3 * @defgroup Database Database
5 * This file deals with database interface functions
6 * and query specifics/optimisations.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
26 namespace Wikimedia\Rdbms
;
28 use Psr\Log\LoggerAwareInterface
;
29 use Psr\Log\LoggerInterface
;
30 use Psr\Log\NullLogger
;
31 use Wikimedia\ScopedCallback
;
32 use Wikimedia\Timestamp\ConvertibleTimestamp
;
37 use InvalidArgumentException
;
38 use UnexpectedValueException
;
43 * Relational database abstraction object
48 abstract class Database
implements IDatabase
, IMaintainableDatabase
, LoggerAwareInterface
{
49 /** Number of times to re-try an operation in case of deadlock */
50 const DEADLOCK_TRIES
= 4;
51 /** Minimum time to wait before retry, in microseconds */
52 const DEADLOCK_DELAY_MIN
= 500000;
53 /** Maximum time to wait before retry */
54 const DEADLOCK_DELAY_MAX
= 1500000;
56 /** How long before it is worth doing a dummy query to test the connection */
58 const PING_QUERY
= 'SELECT 1 AS ping';
60 const TINY_WRITE_SEC
= 0.010;
61 const SLOW_WRITE_SEC
= 0.500;
62 const SMALL_WRITE_ROWS
= 100;
64 /** @var string Whether lock granularity is on the level of the entire database */
65 const ATTR_DB_LEVEL_LOCKING
= 'db-level-locking';
67 /** @var int New Database instance will not be connected yet when returned */
68 const NEW_UNCONNECTED
= 0;
69 /** @var int New Database instance will already be connected when returned */
70 const NEW_CONNECTED
= 1;
72 /** @var string SQL query */
73 protected $lastQuery = '';
74 /** @var float|bool UNIX timestamp of last write query */
75 protected $lastWriteTime = false;
76 /** @var string|bool */
77 protected $phpError = false;
78 /** @var string Server that this instance is currently connected to */
80 /** @var string User that this instance is currently connected under the name of */
82 /** @var string Password used to establish the current connection */
84 /** @var array[] Map of (table => (dbname, schema, prefix) map) */
85 protected $tableAliases = [];
86 /** @var string[] Map of (index alias => index) */
87 protected $indexAliases = [];
88 /** @var bool Whether this PHP instance is for a CLI script */
90 /** @var string Agent name for query profiling */
92 /** @var array Parameters used by initConnection() to establish a connection */
93 protected $connectionParams = [];
94 /** @var BagOStuff APC cache */
96 /** @var LoggerInterface */
97 protected $connLogger;
98 /** @var LoggerInterface */
99 protected $queryLogger;
100 /** @var callback Error logging callback */
101 protected $errorLogger;
102 /** @var callback Deprecation logging callback */
103 protected $deprecationLogger;
105 /** @var resource|null Database connection */
106 protected $conn = null;
108 protected $opened = false;
110 /** @var array[] List of (callable, method name, atomic section id) */
111 protected $trxIdleCallbacks = [];
112 /** @var array[] List of (callable, method name, atomic section id) */
113 protected $trxPreCommitCallbacks = [];
114 /** @var array[] List of (callable, method name, atomic section id) */
115 protected $trxEndCallbacks = [];
116 /** @var callable[] Map of (name => callable) */
117 protected $trxRecurringCallbacks = [];
118 /** @var bool Whether to suppress triggering of transaction end callbacks */
119 protected $trxEndCallbacksSuppressed = false;
124 protected $lbInfo = [];
125 /** @var array|bool */
126 protected $schemaVars = false;
128 protected $sessionVars = [];
129 /** @var array|null */
130 protected $preparedArgs;
131 /** @var string|bool|null Stashed value of html_errors INI setting */
132 protected $htmlErrors;
134 protected $delimiter = ';';
135 /** @var DatabaseDomain */
136 protected $currentDomain;
137 /** @var integer|null Rows affected by the last query to query() or its CRUD wrappers */
138 protected $affectedRowCount;
141 * @var int Transaction status
143 protected $trxStatus = self
::STATUS_TRX_NONE
;
145 * @var Exception|null The last error that caused the status to become STATUS_TRX_ERROR
147 protected $trxStatusCause;
149 * @var array|null If wasKnownStatementRollbackError() prevented trxStatus from being set,
150 * the relevant details are stored here.
152 protected $trxStatusIgnoredCause;
154 * Either 1 if a transaction is active or 0 otherwise.
155 * The other Trx fields may not be meaningfull if this is 0.
159 protected $trxLevel = 0;
161 * Either a short hexidecimal string if a transaction is active or ""
164 * @see Database::trxLevel
166 protected $trxShortId = '';
168 * The UNIX time that the transaction started. Callers can assume that if
169 * snapshot isolation is used, then the data is *at least* up to date to that
170 * point (possibly more up-to-date since the first SELECT defines the snapshot).
173 * @see Database::trxLevel
175 private $trxTimestamp = null;
176 /** @var float Lag estimate at the time of BEGIN */
177 private $trxReplicaLag = null;
179 * Remembers the function name given for starting the most recent transaction via begin().
180 * Used to provide additional context for error reporting.
183 * @see Database::trxLevel
185 private $trxFname = null;
187 * Record if possible write queries were done in the last transaction started
190 * @see Database::trxLevel
192 private $trxDoneWrites = false;
194 * Record if the current transaction was started implicitly due to DBO_TRX being set.
197 * @see Database::trxLevel
199 private $trxAutomatic = false;
201 * Counter for atomic savepoint identifiers. Reset when a new transaction begins.
205 private $trxAtomicCounter = 0;
207 * Array of levels of atomicity within transactions
209 * @var array List of (name, unique ID, savepoint ID)
211 private $trxAtomicLevels = [];
213 * Record if the current transaction was started implicitly by Database::startAtomic
217 private $trxAutomaticAtomic = false;
219 * Track the write query callers of the current transaction
223 private $trxWriteCallers = [];
225 * @var float Seconds spent in write queries for the current transaction
227 private $trxWriteDuration = 0.0;
229 * @var int Number of write queries for the current transaction
231 private $trxWriteQueryCount = 0;
233 * @var int Number of rows affected by write queries for the current transaction
235 private $trxWriteAffectedRows = 0;
237 * @var float Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries
239 private $trxWriteAdjDuration = 0.0;
241 * @var int Number of write queries counted in trxWriteAdjDuration
243 private $trxWriteAdjQueryCount = 0;
245 * @var float RTT time estimate
247 private $rttEstimate = 0.0;
249 /** @var array Map of (name => 1) for locks obtained via lock() */
250 private $namedLocksHeld = [];
251 /** @var array Map of (table name => 1) for TEMPORARY tables */
252 protected $sessionTempTables = [];
254 /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
255 private $lazyMasterHandle;
257 /** @var float UNIX timestamp */
258 protected $lastPing = 0.0;
260 /** @var int[] Prior flags member variable values */
261 private $priorFlags = [];
263 /** @var mixed Class name or object With profileIn/profileOut methods */
265 /** @var TransactionProfiler */
266 protected $trxProfiler;
269 protected $nonNativeInsertSelectBatchSize = 10000;
271 /** @var string Idiom used when a cancelable atomic section started the transaction */
272 private static $NOT_APPLICABLE = 'n/a';
273 /** @var string Prefix to the atomic section counter used to make savepoint IDs */
274 private static $SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic';
276 /** @var int Transaction is in a error state requiring a full or savepoint rollback */
277 const STATUS_TRX_ERROR
= 1;
278 /** @var int Transaction is active and in a normal state */
279 const STATUS_TRX_OK
= 2;
280 /** @var int No transaction is active */
281 const STATUS_TRX_NONE
= 3;
284 * @note exceptions for missing libraries/drivers should be thrown in initConnection()
285 * @param array $params Parameters passed from Database::factory()
287 protected function __construct( array $params ) {
288 foreach ( [ 'host', 'user', 'password', 'dbname', 'schema', 'tablePrefix' ] as $name ) {
289 $this->connectionParams
[$name] = $params[$name];
292 $this->cliMode
= $params['cliMode'];
293 // Agent name is added to SQL queries in a comment, so make sure it can't break out
294 $this->agent
= str_replace( '/', '-', $params['agent'] );
296 $this->flags
= $params['flags'];
297 if ( $this->flags
& self
::DBO_DEFAULT
) {
298 if ( $this->cliMode
) {
299 $this->flags
&= ~self
::DBO_TRX
;
301 $this->flags |
= self
::DBO_TRX
;
304 // Disregard deprecated DBO_IGNORE flag (T189999)
305 $this->flags
&= ~self
::DBO_IGNORE
;
307 $this->sessionVars
= $params['variables'];
309 $this->srvCache
= $params['srvCache'] ??
new HashBagOStuff();
311 $this->profiler
= $params['profiler'];
312 $this->trxProfiler
= $params['trxProfiler'];
313 $this->connLogger
= $params['connLogger'];
314 $this->queryLogger
= $params['queryLogger'];
315 $this->errorLogger
= $params['errorLogger'];
316 $this->deprecationLogger
= $params['deprecationLogger'];
318 if ( isset( $params['nonNativeInsertSelectBatchSize'] ) ) {
319 $this->nonNativeInsertSelectBatchSize
= $params['nonNativeInsertSelectBatchSize'];
322 // Set initial dummy domain until open() sets the final DB/prefix
323 $this->currentDomain
= new DatabaseDomain(
324 $params['dbname'] != '' ?
$params['dbname'] : null,
325 $params['schema'] != '' ?
$params['schema'] : null,
326 $params['tablePrefix']
331 * Initialize the connection to the database over the wire (or to local files)
333 * @throws LogicException
334 * @throws InvalidArgumentException
335 * @throws DBConnectionError
338 final public function initConnection() {
339 if ( $this->isOpen() ) {
340 throw new LogicException( __METHOD__
. ': already connected.' );
342 // Establish the connection
343 $this->doInitConnection();
347 * Actually connect to the database over the wire (or to local files)
349 * @throws InvalidArgumentException
350 * @throws DBConnectionError
353 protected function doInitConnection() {
354 if ( strlen( $this->connectionParams
['user'] ) ) {
356 $this->connectionParams
['host'],
357 $this->connectionParams
['user'],
358 $this->connectionParams
['password'],
359 $this->connectionParams
['dbname'],
360 $this->connectionParams
['schema'],
361 $this->connectionParams
['tablePrefix']
364 throw new InvalidArgumentException( "No database user provided." );
369 * Open a new connection to the database (closing any existing one)
371 * @param string $server Database server host
372 * @param string $user Database user name
373 * @param string $password Database user password
374 * @param string $dbName Database name
375 * @param string|null $schema Database schema name
376 * @param string $tablePrefix Table prefix
378 * @throws DBConnectionError
380 abstract protected function open( $server, $user, $password, $dbName, $schema, $tablePrefix );
383 * Construct a Database subclass instance given a database type and parameters
385 * This also connects to the database immediately upon object construction
387 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
388 * @param array $p Parameter map with keys:
389 * - host : The hostname of the DB server
390 * - user : The name of the database user the client operates under
391 * - password : The password for the database user
392 * - dbname : The name of the database to use where queries do not specify one.
393 * The database must exist or an error might be thrown. Setting this to the empty string
394 * will avoid any such errors and make the handle have no implicit database scope. This is
395 * useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
396 * "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
397 * in which user names and such are defined, e.g. users are database-specific in Postgres.
398 * - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
399 * equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
400 * - tablePrefix : Optional table prefix that is implicitly added on to all table names
401 * recognized in queries. This can be used in place of schemas for handle site farms.
402 * - flags : Optional bitfield of DBO_* constants that define connection, protocol,
403 * buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
404 * flag in place UNLESS this this database simply acts as a key/value store.
405 * - driver: Optional name of a specific DB client driver. For MySQL, there is only the
406 * 'mysqli' driver; the old one 'mysql' has been removed.
407 * - variables: Optional map of session variables to set after connecting. This can be
408 * used to adjust lock timeouts or encoding modes and the like.
409 * - connLogger: Optional PSR-3 logger interface instance.
410 * - queryLogger: Optional PSR-3 logger interface instance.
411 * - profiler: Optional class name or object with profileIn()/profileOut() methods.
412 * These will be called in query(), using a simplified version of the SQL that also
413 * includes the agent as a SQL comment.
414 * - trxProfiler: Optional TransactionProfiler instance.
415 * - errorLogger: Optional callback that takes an Exception and logs it.
416 * - deprecationLogger: Optional callback that takes a string and logs it.
417 * - cliMode: Whether to consider the execution context that of a CLI script.
418 * - agent: Optional name used to identify the end-user in query profiling/logging.
419 * - srvCache: Optional BagOStuff instance to an APC-style cache.
420 * - nonNativeInsertSelectBatchSize: Optional batch size for non-native INSERT SELECT emulation.
421 * @param int $connect One of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional]
422 * @return Database|null If the database driver or extension cannot be found
423 * @throws InvalidArgumentException If the database driver or extension cannot be found
426 final public static function factory( $dbType, $p = [], $connect = self
::NEW_CONNECTED
) {
427 $class = self
::getClass( $dbType, $p['driver'] ??
null );
429 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase
::class ) ) {
430 // Resolve some defaults for b/c
431 $p['host'] = $p['host'] ??
false;
432 $p['user'] = $p['user'] ??
false;
433 $p['password'] = $p['password'] ??
false;
434 $p['dbname'] = $p['dbname'] ??
false;
435 $p['flags'] = $p['flags'] ??
0;
436 $p['variables'] = $p['variables'] ??
[];
437 $p['tablePrefix'] = $p['tablePrefix'] ??
'';
438 $p['schema'] = $p['schema'] ??
null;
439 $p['cliMode'] = $p['cliMode'] ??
( PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg' );
440 $p['agent'] = $p['agent'] ??
'';
441 if ( !isset( $p['connLogger'] ) ) {
442 $p['connLogger'] = new NullLogger();
444 if ( !isset( $p['queryLogger'] ) ) {
445 $p['queryLogger'] = new NullLogger();
447 $p['profiler'] = $p['profiler'] ??
null;
448 if ( !isset( $p['trxProfiler'] ) ) {
449 $p['trxProfiler'] = new TransactionProfiler();
451 if ( !isset( $p['errorLogger'] ) ) {
452 $p['errorLogger'] = function ( Exception
$e ) {
453 trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING
);
456 if ( !isset( $p['deprecationLogger'] ) ) {
457 $p['deprecationLogger'] = function ( $msg ) {
458 trigger_error( $msg, E_USER_DEPRECATED
);
462 /** @var Database $conn */
463 $conn = new $class( $p );
464 if ( $connect == self
::NEW_CONNECTED
) {
465 $conn->initConnection();
475 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
476 * @param string|null $driver Optional name of a specific DB client driver
477 * @return array Map of (Database::ATTRIBUTE_* constant => value) for all such constants
478 * @throws InvalidArgumentException
481 final public static function attributesFromType( $dbType, $driver = null ) {
482 static $defaults = [ self
::ATTR_DB_LEVEL_LOCKING
=> false ];
484 $class = self
::getClass( $dbType, $driver );
486 return call_user_func( [ $class, 'getAttributes' ] ) +
$defaults;
490 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
491 * @param string|null $driver Optional name of a specific DB client driver
492 * @return string Database subclass name to use
493 * @throws InvalidArgumentException
495 private static function getClass( $dbType, $driver = null ) {
496 // For database types with built-in support, the below maps type to IDatabase
497 // implementations. For types with multipe driver implementations (PHP extensions),
498 // an array can be used, keyed by extension name. In case of an array, the
499 // optional 'driver' parameter can be used to force a specific driver. Otherwise,
500 // we auto-detect the first available driver. For types without built-in support,
501 // an class named "Database<Type>" us used, eg. DatabaseFoo for type 'foo'.
502 static $builtinTypes = [
503 'mssql' => DatabaseMssql
::class,
504 'mysql' => [ 'mysqli' => DatabaseMysqli
::class ],
505 'sqlite' => DatabaseSqlite
::class,
506 'postgres' => DatabasePostgres
::class,
509 $dbType = strtolower( $dbType );
512 if ( isset( $builtinTypes[$dbType] ) ) {
513 $possibleDrivers = $builtinTypes[$dbType];
514 if ( is_string( $possibleDrivers ) ) {
515 $class = $possibleDrivers;
517 if ( (string)$driver !== '' ) {
518 if ( !isset( $possibleDrivers[$driver] ) ) {
519 throw new InvalidArgumentException( __METHOD__
.
520 " type '$dbType' does not support driver '{$driver}'" );
522 $class = $possibleDrivers[$driver];
525 foreach ( $possibleDrivers as $posDriver => $possibleClass ) {
526 if ( extension_loaded( $posDriver ) ) {
527 $class = $possibleClass;
534 $class = 'Database' . ucfirst( $dbType );
537 if ( $class === false ) {
538 throw new InvalidArgumentException( __METHOD__
.
539 " no viable database extension found for type '$dbType'" );
546 * @return array Map of (Database::ATTRIBUTE_* constant => value
549 protected static function getAttributes() {
554 * Set the PSR-3 logger interface to use for query logging. (The logger
555 * interfaces for connection logging and error logging can be set with the
558 * @param LoggerInterface $logger
560 public function setLogger( LoggerInterface
$logger ) {
561 $this->queryLogger
= $logger;
564 public function getServerInfo() {
565 return $this->getServerVersion();
568 public function bufferResults( $buffer = null ) {
569 $res = !$this->getFlag( self
::DBO_NOBUFFER
);
570 if ( $buffer !== null ) {
572 ?
$this->clearFlag( self
::DBO_NOBUFFER
)
573 : $this->setFlag( self
::DBO_NOBUFFER
);
579 public function trxLevel() {
580 return $this->trxLevel
;
583 public function trxTimestamp() {
584 return $this->trxLevel ?
$this->trxTimestamp
: null;
588 * @return int One of the STATUS_TRX_* class constants
591 public function trxStatus() {
592 return $this->trxStatus
;
595 public function tablePrefix( $prefix = null ) {
596 $old = $this->currentDomain
->getTablePrefix();
597 if ( $prefix !== null ) {
598 $this->currentDomain
= new DatabaseDomain(
599 $this->currentDomain
->getDatabase(),
600 $this->currentDomain
->getSchema(),
608 public function dbSchema( $schema = null ) {
609 $old = $this->currentDomain
->getSchema();
610 if ( $schema !== null ) {
611 $this->currentDomain
= new DatabaseDomain(
612 $this->currentDomain
->getDatabase(),
613 // DatabaseDomain uses null for unspecified schemas
614 strlen( $schema ) ?
$schema : null,
615 $this->currentDomain
->getTablePrefix()
623 * @return string Schema to use to qualify relations in queries
625 protected function relationSchemaQualifier() {
626 return $this->dbSchema();
629 public function getLBInfo( $name = null ) {
630 if ( is_null( $name ) ) {
631 return $this->lbInfo
;
633 if ( array_key_exists( $name, $this->lbInfo
) ) {
634 return $this->lbInfo
[$name];
641 public function setLBInfo( $name, $value = null ) {
642 if ( is_null( $value ) ) {
643 $this->lbInfo
= $name;
645 $this->lbInfo
[$name] = $value;
649 public function setLazyMasterHandle( IDatabase
$conn ) {
650 $this->lazyMasterHandle
= $conn;
654 * @return IDatabase|null
655 * @see setLazyMasterHandle()
658 protected function getLazyMasterHandle() {
659 return $this->lazyMasterHandle
;
662 public function implicitGroupby() {
666 public function implicitOrderby() {
670 public function lastQuery() {
671 return $this->lastQuery
;
674 public function doneWrites() {
675 return (bool)$this->lastWriteTime
;
678 public function lastDoneWrites() {
679 return $this->lastWriteTime ?
: false;
682 public function writesPending() {
683 return $this->trxLevel
&& $this->trxDoneWrites
;
686 public function writesOrCallbacksPending() {
687 return $this->trxLevel
&& (
688 $this->trxDoneWrites ||
689 $this->trxIdleCallbacks ||
690 $this->trxPreCommitCallbacks ||
691 $this->trxEndCallbacks
695 public function preCommitCallbacksPending() {
696 return $this->trxLevel
&& $this->trxPreCommitCallbacks
;
700 * @return string|null
702 final protected function getTransactionRoundId() {
703 // If transaction round participation is enabled, see if one is active
704 if ( $this->getFlag( self
::DBO_TRX
) ) {
705 $id = $this->getLBInfo( 'trxRoundId' );
707 return is_string( $id ) ?
$id : null;
713 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
) {
714 if ( !$this->trxLevel
) {
716 } elseif ( !$this->trxDoneWrites
) {
721 case self
::ESTIMATE_DB_APPLY
:
723 $rttAdjTotal = $this->trxWriteAdjQueryCount
* $rtt;
724 $applyTime = max( $this->trxWriteAdjDuration
- $rttAdjTotal, 0 );
725 // For omitted queries, make them count as something at least
726 $omitted = $this->trxWriteQueryCount
- $this->trxWriteAdjQueryCount
;
727 $applyTime +
= self
::TINY_WRITE_SEC
* $omitted;
730 default: // everything
731 return $this->trxWriteDuration
;
735 public function pendingWriteCallers() {
736 return $this->trxLevel ?
$this->trxWriteCallers
: [];
739 public function pendingWriteRowsAffected() {
740 return $this->trxWriteAffectedRows
;
744 * List the methods that have write queries or callbacks for the current transaction
746 * This method should not be used outside of Database/LoadBalancer
751 public function pendingWriteAndCallbackCallers() {
752 $fnames = $this->pendingWriteCallers();
754 $this->trxIdleCallbacks
,
755 $this->trxPreCommitCallbacks
,
756 $this->trxEndCallbacks
758 foreach ( $callbacks as $callback ) {
759 $fnames[] = $callback[1];
769 private function flatAtomicSectionList() {
770 return array_reduce( $this->trxAtomicLevels
, function ( $accum, $v ) {
771 return $accum === null ?
$v[0] : "$accum, " . $v[0];
775 public function isOpen() {
776 return $this->opened
;
779 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
780 if ( ( $flag & self
::DBO_IGNORE
) ) {
781 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
784 if ( $remember === self
::REMEMBER_PRIOR
) {
785 array_push( $this->priorFlags
, $this->flags
);
787 $this->flags |
= $flag;
790 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
791 if ( ( $flag & self
::DBO_IGNORE
) ) {
792 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
795 if ( $remember === self
::REMEMBER_PRIOR
) {
796 array_push( $this->priorFlags
, $this->flags
);
798 $this->flags
&= ~
$flag;
801 public function restoreFlags( $state = self
::RESTORE_PRIOR
) {
802 if ( !$this->priorFlags
) {
806 if ( $state === self
::RESTORE_INITIAL
) {
807 $this->flags
= reset( $this->priorFlags
);
808 $this->priorFlags
= [];
810 $this->flags
= array_pop( $this->priorFlags
);
814 public function getFlag( $flag ) {
815 return !!( $this->flags
& $flag );
819 * @param string $name Class field name
821 * @deprecated Since 1.28
823 public function getProperty( $name ) {
827 public function getDomainID() {
828 return $this->currentDomain
->getId();
831 final public function getWikiID() {
832 return $this->getDomainID();
836 * Get information about an index into an object
837 * @param string $table Table name
838 * @param string $index Index name
839 * @param string $fname Calling function name
840 * @return mixed Database-specific index description class or false if the index does not exist
842 abstract function indexInfo( $table, $index, $fname = __METHOD__
);
845 * Wrapper for addslashes()
847 * @param string $s String to be slashed.
848 * @return string Slashed string.
850 abstract function strencode( $s );
853 * Set a custom error handler for logging errors during database connection
855 protected function installErrorHandler() {
856 $this->phpError
= false;
857 $this->htmlErrors
= ini_set( 'html_errors', '0' );
858 set_error_handler( [ $this, 'connectionErrorLogger' ] );
862 * Restore the previous error handler and return the last PHP error for this DB
864 * @return bool|string
866 protected function restoreErrorHandler() {
867 restore_error_handler();
868 if ( $this->htmlErrors
!== false ) {
869 ini_set( 'html_errors', $this->htmlErrors
);
872 return $this->getLastPHPError();
876 * @return string|bool Last PHP error for this DB (typically connection errors)
878 protected function getLastPHPError() {
879 if ( $this->phpError
) {
880 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->phpError
);
881 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
890 * Error handler for logging errors during database connection
891 * This method should not be used outside of Database classes
894 * @param string $errstr
896 public function connectionErrorLogger( $errno, $errstr ) {
897 $this->phpError
= $errstr;
901 * Create a log context to pass to PSR-3 logger functions.
903 * @param array $extras Additional data to add to context
906 protected function getLogContext( array $extras = [] ) {
909 'db_server' => $this->server
,
910 'db_name' => $this->getDBname(),
911 'db_user' => $this->user
,
917 final public function close() {
918 $exception = null; // error to throw after disconnecting
921 // Roll back any dangling transaction first
922 if ( $this->trxLevel
) {
923 if ( $this->trxAtomicLevels
) {
924 // Cannot let incomplete atomic sections be committed
925 $levels = $this->flatAtomicSectionList();
926 $exception = new DBUnexpectedError(
928 __METHOD__
. ": atomic sections $levels are still open."
930 } elseif ( $this->trxAutomatic
) {
931 // Only the connection manager can commit non-empty DBO_TRX transactions
932 // (empty ones we can silently roll back)
933 if ( $this->writesOrCallbacksPending() ) {
934 $exception = new DBUnexpectedError(
937 ": mass commit/rollback of peer transaction required (DBO_TRX set)."
941 // Manual transactions should have been committed or rolled
942 // back, even if empty.
943 $exception = new DBUnexpectedError(
945 __METHOD__
. ": transaction is still open (from {$this->trxFname})."
949 if ( $this->trxEndCallbacksSuppressed
) {
950 $exception = $exception ?
: new DBUnexpectedError(
952 __METHOD__
. ': callbacks are suppressed; cannot properly commit.'
956 // Rollback the changes and run any callbacks as needed
957 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
960 // Close the actual connection in the binding handle
961 $closed = $this->closeConnection();
964 $closed = true; // already closed; nothing to do
967 $this->opened
= false;
969 // Throw any unexpected errors after having disconnected
970 if ( $exception instanceof Exception
) {
974 // Sanity check that no callbacks are dangling
975 $fnames = $this->pendingWriteAndCallbackCallers();
977 throw new RuntimeException(
978 "Transaction callbacks are still pending:\n" . implode( ', ', $fnames )
986 * Make sure isOpen() returns true as a sanity check
988 * @throws DBUnexpectedError
990 protected function assertOpen() {
991 if ( !$this->isOpen() ) {
992 throw new DBUnexpectedError( $this, "DB connection was already closed." );
997 * Closes underlying database connection
999 * @return bool Whether connection was closed successfully
1001 abstract protected function closeConnection();
1004 * @deprecated since 1.32
1005 * @param string $error Fallback message, if none is given by DB
1006 * @throws DBConnectionError
1008 public function reportConnectionError( $error = 'Unknown error' ) {
1009 call_user_func( $this->deprecationLogger
, 'Use of ' . __METHOD__
. ' is deprecated.' );
1010 throw new DBConnectionError( $this, $this->lastError() ?
: $error );
1014 * Run a query and return a DBMS-dependent wrapper (that has all IResultWrapper methods)
1016 * This might return things, such as mysqli_result, that do not formally implement
1017 * IResultWrapper, but nonetheless implement all of its methods correctly
1019 * @param string $sql SQL query.
1020 * @return IResultWrapper|bool Iterator to feed to fetchObject/fetchRow; false on failure
1022 abstract protected function doQuery( $sql );
1025 * Determine whether a query writes to the DB. When in doubt, this returns true.
1029 * - Subsequent web requests should not need to wait for replication from
1030 * the master position seen by this web request, unless this request made
1031 * changes to the master. This is handled by ChronologyProtector by checking
1032 * doneWrites() at the end of the request. doneWrites() returns true if any
1033 * query set lastWriteTime; which query() does based on isWriteQuery().
1035 * - Reject write queries to replica DBs, in query().
1037 * @param string $sql
1040 protected function isWriteQuery( $sql ) {
1041 // BEGIN and COMMIT queries are considered read queries here.
1042 // Database backends and drivers (MySQL, MariaDB, php-mysqli) generally
1043 // treat these as write queries, in that their results have "affected rows"
1044 // as meta data as from writes, instead of "num rows" as from reads.
1045 // But, we treat them as read queries because when reading data (from
1046 // either replica or master) we use transactions to enable repeatable-read
1047 // snapshots, which ensures we get consistent results from the same snapshot
1048 // for all queries within a request. Use cases:
1049 // - Treating these as writes would trigger ChronologyProtector (see method doc).
1050 // - We use this method to reject writes to replicas, but we need to allow
1051 // use of transactions on replicas for read snapshots. This fine given
1052 // that transactions by themselves don't make changes, only actual writes
1053 // within the transaction matter, which we still detect.
1055 '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SAVEPOINT|RELEASE|SET|SHOW|EXPLAIN|\(SELECT)\b/i',
1061 * @param string $sql
1062 * @return string|null
1064 protected function getQueryVerb( $sql ) {
1065 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ?
strtoupper( $m[1] ) : null;
1069 * Determine whether a SQL statement is sensitive to isolation level.
1071 * A SQL statement is considered transactable if its result could vary
1072 * depending on the transaction isolation level. Operational commands
1073 * such as 'SET' and 'SHOW' are not considered to be transactable.
1075 * Main purpose: Used by query() to decide whether to begin a transaction
1076 * before the current query (in DBO_TRX mode, on by default).
1078 * @param string $sql
1081 protected function isTransactableQuery( $sql ) {
1083 $this->getQueryVerb( $sql ),
1084 [ 'BEGIN', 'ROLLBACK', 'COMMIT', 'SET', 'SHOW', 'CREATE', 'ALTER' ],
1090 * @param string $sql A SQL query
1091 * @return bool Whether $sql is SQL for TEMPORARY table operation
1093 protected function registerTempTableOperation( $sql ) {
1095 '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1099 $this->sessionTempTables
[$matches[1]] = 1;
1102 } elseif ( preg_match(
1103 '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1107 $isTemp = isset( $this->sessionTempTables
[$matches[1]] );
1108 unset( $this->sessionTempTables
[$matches[1]] );
1111 } elseif ( preg_match(
1112 '/^TRUNCATE\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1116 return isset( $this->sessionTempTables
[$matches[1]] );
1117 } elseif ( preg_match(
1118 '/^(?:INSERT\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+[`"\']?(\w+)[`"\']?/i',
1122 return isset( $this->sessionTempTables
[$matches[1]] );
1128 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
1129 $this->assertTransactionStatus( $sql, $fname );
1131 # Avoid fatals if close() was called
1132 $this->assertOpen();
1134 $priorWritesPending = $this->writesOrCallbacksPending();
1135 $this->lastQuery
= $sql;
1137 $isWrite = $this->isWriteQuery( $sql );
1139 $isNonTempWrite = !$this->registerTempTableOperation( $sql );
1141 $isNonTempWrite = false;
1145 if ( $this->getLBInfo( 'replica' ) === true ) {
1148 'Write operations are not allowed on replica database connections.'
1151 # In theory, non-persistent writes are allowed in read-only mode, but due to things
1152 # like https://bugs.mysql.com/bug.php?id=33669 that might not work anyway...
1153 $reason = $this->getReadOnlyReason();
1154 if ( $reason !== false ) {
1155 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
1157 # Set a flag indicating that writes have been done
1158 $this->lastWriteTime
= microtime( true );
1161 # Add trace comment to the begin of the sql string, right after the operator.
1162 # Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
1163 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
1165 # Start implicit transactions that wrap the request if DBO_TRX is enabled
1166 if ( !$this->trxLevel
&& $this->getFlag( self
::DBO_TRX
)
1167 && $this->isTransactableQuery( $sql )
1169 $this->begin( __METHOD__
. " ($fname)", self
::TRANSACTION_INTERNAL
);
1170 $this->trxAutomatic
= true;
1173 # Keep track of whether the transaction has write queries pending
1174 if ( $this->trxLevel
&& !$this->trxDoneWrites
&& $isWrite ) {
1175 $this->trxDoneWrites
= true;
1176 $this->trxProfiler
->transactionWritingIn(
1177 $this->server
, $this->getDomainID(), $this->trxShortId
);
1180 if ( $this->getFlag( self
::DBO_DEBUG
) ) {
1181 $this->queryLogger
->debug( "{$this->getDomainID()} {$commentedSql}" );
1184 # Send the query to the server and fetch any corresponding errors
1185 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1186 $lastError = $this->lastError();
1187 $lastErrno = $this->lastErrno();
1189 # Try reconnecting if the connection was lost
1190 if ( $ret === false && $this->wasConnectionLoss() ) {
1191 # Check if any meaningful session state was lost
1192 $recoverable = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
1193 # Update session state tracking and try to restore the connection
1194 $reconnected = $this->replaceLostConnection( __METHOD__
);
1195 # Silently resend the query to the server if it is safe and possible
1196 if ( $reconnected && $recoverable ) {
1197 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1198 $lastError = $this->lastError();
1199 $lastErrno = $this->lastErrno();
1201 if ( $ret === false && $this->wasConnectionLoss() ) {
1202 # Query probably causes disconnects; reconnect and do not re-run it
1203 $this->replaceLostConnection( __METHOD__
);
1208 if ( $ret === false ) {
1209 if ( $this->trxLevel
) {
1210 if ( $this->wasKnownStatementRollbackError() ) {
1211 # We're ignoring an error that caused just the current query to be aborted.
1212 # But log the cause so we can log a deprecation notice if a caller actually
1214 $this->trxStatusIgnoredCause
= [ $lastError, $lastErrno, $fname ];
1216 # Either the query was aborted or all queries after BEGIN where aborted.
1217 # In the first case, the only options going forward are (a) ROLLBACK, or
1218 # (b) ROLLBACK TO SAVEPOINT (if one was set). If the later case, the only
1219 # option is ROLLBACK, since the snapshots would have been released.
1220 $this->trxStatus
= self
::STATUS_TRX_ERROR
;
1221 $this->trxStatusCause
=
1222 $this->makeQueryException( $lastError, $lastErrno, $sql, $fname );
1223 $tempIgnore = false; // cannot recover
1224 $this->trxStatusIgnoredCause
= null;
1228 $this->reportQueryError( $lastError, $lastErrno, $sql, $fname, $tempIgnore );
1231 return $this->resultObject( $ret );
1235 * Wrapper for query() that also handles profiling, logging, and affected row count updates
1237 * @param string $sql Original SQL query
1238 * @param string $commentedSql SQL query with debugging/trace comment
1239 * @param bool $isWrite Whether the query is a (non-temporary) write operation
1240 * @param string $fname Name of the calling function
1241 * @return bool|ResultWrapper True for a successful write query, ResultWrapper
1242 * object for a successful read query, or false on failure
1244 private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
1245 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1246 # generalizeSQL() will probably cut down the query to reasonable
1247 # logging size most of the time. The substr is really just a sanity check.
1249 $queryProf = 'query-m: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
1251 $queryProf = 'query: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
1254 # Include query transaction state
1255 $queryProf .= $this->trxShortId ?
" [TRX#{$this->trxShortId}]" : "";
1257 $startTime = microtime( true );
1258 if ( $this->profiler
) {
1259 $this->profiler
->profileIn( $queryProf );
1261 $this->affectedRowCount
= null;
1262 $ret = $this->doQuery( $commentedSql );
1263 $this->affectedRowCount
= $this->affectedRows();
1264 if ( $this->profiler
) {
1265 $this->profiler
->profileOut( $queryProf );
1267 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
1269 unset( $queryProfSection ); // profile out (if set)
1271 if ( $ret !== false ) {
1272 $this->lastPing
= $startTime;
1273 if ( $isWrite && $this->trxLevel
) {
1274 $this->updateTrxWriteQueryTime( $sql, $queryRuntime, $this->affectedRows() );
1275 $this->trxWriteCallers
[] = $fname;
1279 if ( $sql === self
::PING_QUERY
) {
1280 $this->rttEstimate
= $queryRuntime;
1283 $this->trxProfiler
->recordQueryCompletion(
1287 $isWrite ?
$this->affectedRows() : $this->numRows( $ret )
1289 $this->queryLogger
->debug( $sql, [
1291 'master' => $isMaster,
1292 'runtime' => $queryRuntime,
1299 * Update the estimated run-time of a query, not counting large row lock times
1301 * LoadBalancer can be set to rollback transactions that will create huge replication
1302 * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
1303 * queries, like inserting a row can take a long time due to row locking. This method
1304 * uses some simple heuristics to discount those cases.
1306 * @param string $sql A SQL write query
1307 * @param float $runtime Total runtime, including RTT
1308 * @param int $affected Affected row count
1310 private function updateTrxWriteQueryTime( $sql, $runtime, $affected ) {
1311 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1312 $indicativeOfReplicaRuntime = true;
1313 if ( $runtime > self
::SLOW_WRITE_SEC
) {
1314 $verb = $this->getQueryVerb( $sql );
1315 // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1316 if ( $verb === 'INSERT' ) {
1317 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
;
1318 } elseif ( $verb === 'REPLACE' ) {
1319 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
/ 2;
1323 $this->trxWriteDuration +
= $runtime;
1324 $this->trxWriteQueryCount +
= 1;
1325 $this->trxWriteAffectedRows +
= $affected;
1326 if ( $indicativeOfReplicaRuntime ) {
1327 $this->trxWriteAdjDuration +
= $runtime;
1328 $this->trxWriteAdjQueryCount +
= 1;
1333 * @param string $sql
1334 * @param string $fname
1335 * @throws DBTransactionStateError
1337 private function assertTransactionStatus( $sql, $fname ) {
1338 if ( $this->getQueryVerb( $sql ) === 'ROLLBACK' ) { // transaction/savepoint
1342 if ( $this->trxStatus
< self
::STATUS_TRX_OK
) {
1343 throw new DBTransactionStateError(
1345 "Cannot execute query from $fname while transaction status is ERROR.",
1347 $this->trxStatusCause
1349 } elseif ( $this->trxStatus
=== self
::STATUS_TRX_OK
&& $this->trxStatusIgnoredCause
) {
1350 list( $iLastError, $iLastErrno, $iFname ) = $this->trxStatusIgnoredCause
;
1351 call_user_func( $this->deprecationLogger
,
1352 "Caller from $fname ignored an error originally raised from $iFname: " .
1353 "[$iLastErrno] $iLastError"
1355 $this->trxStatusIgnoredCause
= null;
1359 public function assertNoOpenTransactions() {
1360 if ( $this->explicitTrxActive() ) {
1361 throw new DBTransactionError(
1363 "Explicit transaction still active. A caller may have caught an error. "
1364 . "Open transactions: " . $this->flatAtomicSectionList()
1370 * Determine whether or not it is safe to retry queries after a database
1371 * connection is lost
1373 * @param string $sql SQL query
1374 * @param bool $priorWritesPending Whether there is a transaction open with
1375 * possible write queries or transaction pre-commit/idle callbacks
1376 * waiting on it to finish.
1377 * @return bool True if it is safe to retry the query, false otherwise
1379 private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1380 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1381 # Dropped connections also mean that named locks are automatically released.
1382 # Only allow error suppression in autocommit mode or when the lost transaction
1383 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1384 if ( $this->namedLocksHeld
) {
1385 return false; // possible critical section violation
1386 } elseif ( $this->sessionTempTables
) {
1387 return false; // tables might be queried latter
1388 } elseif ( $sql === 'COMMIT' ) {
1389 return !$priorWritesPending; // nothing written anyway? (T127428)
1390 } elseif ( $sql === 'ROLLBACK' ) {
1391 return true; // transaction lost...which is also what was requested :)
1392 } elseif ( $this->explicitTrxActive() ) {
1393 return false; // don't drop atomocity and explicit snapshots
1394 } elseif ( $priorWritesPending ) {
1395 return false; // prior writes lost from implicit transaction
1402 * Clean things up after session (and thus transaction) loss
1404 private function handleSessionLoss() {
1405 // Clean up tracking of session-level things...
1406 // https://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html
1407 // https://www.postgresql.org/docs/9.2/static/sql-createtable.html (ignoring ON COMMIT)
1408 $this->sessionTempTables
= [];
1409 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1410 // https://www.postgresql.org/docs/9.4/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1411 $this->namedLocksHeld
= [];
1412 // Session loss implies transaction loss
1413 $this->handleTransactionLoss();
1417 * Clean things up after transaction loss
1419 private function handleTransactionLoss() {
1420 $this->trxLevel
= 0;
1421 $this->trxAtomicCounter
= 0;
1422 $this->trxIdleCallbacks
= []; // T67263; transaction already lost
1423 $this->trxPreCommitCallbacks
= []; // T67263; transaction already lost
1425 // Handle callbacks in trxEndCallbacks, e.g. onTransactionResolution().
1426 // If callback suppression is set then the array will remain unhandled.
1427 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
1428 } catch ( Exception
$ex ) {
1429 // Already logged; move on...
1432 // Handle callbacks in trxRecurringCallbacks, e.g. setTransactionListener()
1433 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
1434 } catch ( Exception
$ex ) {
1435 // Already logged; move on...
1440 * Checks whether the cause of the error is detected to be a timeout.
1442 * It returns false by default, and not all engines support detecting this yet.
1443 * If this returns false, it will be treated as a generic query error.
1445 * @param string $error Error text
1446 * @param int $errno Error number
1449 protected function wasQueryTimeout( $error, $errno ) {
1454 * Report a query error. Log the error, and if neither the object ignore
1455 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
1457 * @param string $error
1459 * @param string $sql
1460 * @param string $fname
1461 * @param bool $tempIgnore
1462 * @throws DBQueryError
1464 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1465 if ( $tempIgnore ) {
1466 $this->queryLogger
->debug( "SQL ERROR (ignored): $error\n" );
1468 $exception = $this->makeQueryException( $error, $errno, $sql, $fname );
1475 * @param string $error
1476 * @param string|int $errno
1477 * @param string $sql
1478 * @param string $fname
1481 private function makeQueryException( $error, $errno, $sql, $fname ) {
1482 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1483 $this->queryLogger
->error(
1484 "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1485 $this->getLogContext( [
1486 'method' => __METHOD__
,
1489 'sql1line' => $sql1line,
1493 $this->queryLogger
->debug( "SQL ERROR: " . $error . "\n" );
1494 $wasQueryTimeout = $this->wasQueryTimeout( $error, $errno );
1495 if ( $wasQueryTimeout ) {
1496 $e = new DBQueryTimeoutError( $this, $error, $errno, $sql, $fname );
1498 $e = new DBQueryError( $this, $error, $errno, $sql, $fname );
1504 public function freeResult( $res ) {
1507 public function selectField(
1508 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1510 if ( $var === '*' ) { // sanity
1511 throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1514 if ( !is_array( $options ) ) {
1515 $options = [ $options ];
1518 $options['LIMIT'] = 1;
1520 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1521 if ( $res === false ||
!$this->numRows( $res ) ) {
1525 $row = $this->fetchRow( $res );
1527 if ( $row !== false ) {
1528 return reset( $row );
1534 public function selectFieldValues(
1535 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1537 if ( $var === '*' ) { // sanity
1538 throw new DBUnexpectedError( $this, "Cannot use a * field" );
1539 } elseif ( !is_string( $var ) ) { // sanity
1540 throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1543 if ( !is_array( $options ) ) {
1544 $options = [ $options ];
1547 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1548 if ( $res === false ) {
1553 foreach ( $res as $row ) {
1554 $values[] = $row->$var;
1561 * Returns an optional USE INDEX clause to go after the table, and a
1562 * string to go at the end of the query.
1564 * @param array $options Associative array of options to be turned into
1565 * an SQL query, valid keys are listed in the function.
1567 * @see Database::select()
1569 protected function makeSelectOptions( $options ) {
1570 $preLimitTail = $postLimitTail = '';
1575 foreach ( $options as $key => $option ) {
1576 if ( is_numeric( $key ) ) {
1577 $noKeyOptions[$option] = true;
1581 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1583 $preLimitTail .= $this->makeOrderBy( $options );
1585 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1586 $postLimitTail .= ' FOR UPDATE';
1589 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1590 $postLimitTail .= ' LOCK IN SHARE MODE';
1593 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1594 $startOpts .= 'DISTINCT';
1597 # Various MySQL extensions
1598 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1599 $startOpts .= ' /*! STRAIGHT_JOIN */';
1602 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1603 $startOpts .= ' HIGH_PRIORITY';
1606 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1607 $startOpts .= ' SQL_BIG_RESULT';
1610 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1611 $startOpts .= ' SQL_BUFFER_RESULT';
1614 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1615 $startOpts .= ' SQL_SMALL_RESULT';
1618 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1619 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1622 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1623 $startOpts .= ' SQL_CACHE';
1626 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1627 $startOpts .= ' SQL_NO_CACHE';
1630 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1631 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1635 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1636 $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1641 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1645 * Returns an optional GROUP BY with an optional HAVING
1647 * @param array $options Associative array of options
1649 * @see Database::select()
1652 protected function makeGroupByWithHaving( $options ) {
1654 if ( isset( $options['GROUP BY'] ) ) {
1655 $gb = is_array( $options['GROUP BY'] )
1656 ?
implode( ',', $options['GROUP BY'] )
1657 : $options['GROUP BY'];
1658 $sql .= ' GROUP BY ' . $gb;
1660 if ( isset( $options['HAVING'] ) ) {
1661 $having = is_array( $options['HAVING'] )
1662 ?
$this->makeList( $options['HAVING'], self
::LIST_AND
)
1663 : $options['HAVING'];
1664 $sql .= ' HAVING ' . $having;
1671 * Returns an optional ORDER BY
1673 * @param array $options Associative array of options
1675 * @see Database::select()
1678 protected function makeOrderBy( $options ) {
1679 if ( isset( $options['ORDER BY'] ) ) {
1680 $ob = is_array( $options['ORDER BY'] )
1681 ?
implode( ',', $options['ORDER BY'] )
1682 : $options['ORDER BY'];
1684 return ' ORDER BY ' . $ob;
1690 public function select(
1691 $table, $vars, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1693 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1695 return $this->query( $sql, $fname );
1698 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__
,
1699 $options = [], $join_conds = []
1701 if ( is_array( $vars ) ) {
1702 $fields = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1707 $options = (array)$options;
1708 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1709 ?
$options['USE INDEX']
1712 isset( $options['IGNORE INDEX'] ) &&
1713 is_array( $options['IGNORE INDEX'] )
1715 ?
$options['IGNORE INDEX']
1719 $this->selectOptionsIncludeLocking( $options ) &&
1720 $this->selectFieldsOrOptionsAggregate( $vars, $options )
1722 // Some DB types (postgres/oracle) disallow FOR UPDATE with aggregate
1723 // functions. Discourage use of such queries to encourage compatibility.
1725 $this->deprecationLogger
,
1726 __METHOD__
. ": aggregation used with a locking SELECT ($fname)."
1730 if ( is_array( $table ) ) {
1732 $this->tableNamesWithIndexClauseOrJOIN(
1733 $table, $useIndexes, $ignoreIndexes, $join_conds );
1734 } elseif ( $table != '' ) {
1736 $this->tableNamesWithIndexClauseOrJOIN(
1737 [ $table ], $useIndexes, $ignoreIndexes, [] );
1742 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1743 $this->makeSelectOptions( $options );
1745 if ( is_array( $conds ) ) {
1746 $conds = $this->makeList( $conds, self
::LIST_AND
);
1749 if ( $conds === null ||
$conds === false ) {
1750 $this->queryLogger
->warning(
1754 . ' with incorrect parameters: $conds must be a string or an array'
1759 if ( $conds === '' ||
$conds === '*' ) {
1760 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex $preLimitTail";
1761 } elseif ( is_string( $conds ) ) {
1762 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex " .
1763 "WHERE $conds $preLimitTail";
1765 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
1768 if ( isset( $options['LIMIT'] ) ) {
1769 $sql = $this->limitResult( $sql, $options['LIMIT'],
1770 $options['OFFSET'] ??
false );
1772 $sql = "$sql $postLimitTail";
1774 if ( isset( $options['EXPLAIN'] ) ) {
1775 $sql = 'EXPLAIN ' . $sql;
1781 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
1782 $options = [], $join_conds = []
1784 $options = (array)$options;
1785 $options['LIMIT'] = 1;
1786 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1788 if ( $res === false ) {
1792 if ( !$this->numRows( $res ) ) {
1796 $obj = $this->fetchObject( $res );
1801 public function estimateRowCount(
1802 $table, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1804 $conds = $this->normalizeConditions( $conds, $fname );
1805 $column = $this->extractSingleFieldFromList( $var );
1806 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1807 $conds[] = "$column IS NOT NULL";
1810 $res = $this->select(
1811 $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options, $join_conds
1813 $row = $res ?
$this->fetchRow( $res ) : [];
1815 return isset( $row['rowcount'] ) ?
(int)$row['rowcount'] : 0;
1818 public function selectRowCount(
1819 $tables, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1821 $conds = $this->normalizeConditions( $conds, $fname );
1822 $column = $this->extractSingleFieldFromList( $var );
1823 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1824 $conds[] = "$column IS NOT NULL";
1827 $res = $this->select(
1829 'tmp_count' => $this->buildSelectSubquery(
1838 [ 'rowcount' => 'COUNT(*)' ],
1842 $row = $res ?
$this->fetchRow( $res ) : [];
1844 return isset( $row['rowcount'] ) ?
(int)$row['rowcount'] : 0;
1848 * @param string|array $options
1851 private function selectOptionsIncludeLocking( $options ) {
1852 $options = (array)$options;
1853 foreach ( [ 'FOR UPDATE', 'LOCK IN SHARE MODE' ] as $lock ) {
1854 if ( in_array( $lock, $options, true ) ) {
1863 * @param array|string $fields
1864 * @param array|string $options
1867 private function selectFieldsOrOptionsAggregate( $fields, $options ) {
1868 foreach ( (array)$options as $key => $value ) {
1869 if ( is_string( $key ) ) {
1870 if ( preg_match( '/^(?:GROUP BY|HAVING)$/i', $key ) ) {
1873 } elseif ( is_string( $value ) ) {
1874 if ( preg_match( '/^(?:DISTINCT|DISTINCTROW)$/i', $value ) ) {
1880 $regex = '/^(?:COUNT|MIN|MAX|SUM|GROUP_CONCAT|LISTAGG|ARRAY_AGG)\s*\\(/i';
1881 foreach ( (array)$fields as $field ) {
1882 if ( is_string( $field ) && preg_match( $regex, $field ) ) {
1891 * @param array|string $conds
1892 * @param string $fname
1895 final protected function normalizeConditions( $conds, $fname ) {
1896 if ( $conds === null ||
$conds === false ) {
1897 $this->queryLogger
->warning(
1901 . ' with incorrect parameters: $conds must be a string or an array'
1906 if ( !is_array( $conds ) ) {
1907 $conds = ( $conds === '' ) ?
[] : [ $conds ];
1914 * @param array|string $var Field parameter in the style of select()
1915 * @return string|null Column name or null; ignores aliases
1916 * @throws DBUnexpectedError Errors out if multiple columns are given
1918 final protected function extractSingleFieldFromList( $var ) {
1919 if ( is_array( $var ) ) {
1922 } elseif ( count( $var ) == 1 ) {
1923 $column = $var[0] ??
reset( $var );
1925 throw new DBUnexpectedError( $this, __METHOD__
. ': got multiple columns.' );
1934 public function lockForUpdate(
1935 $table, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1937 if ( !$this->trxLevel
&& !$this->getFlag( self
::DBO_TRX
) ) {
1938 throw new DBUnexpectedError(
1940 __METHOD__
. ': no transaction is active nor is DBO_TRX set'
1944 $options = (array)$options;
1945 $options[] = 'FOR UPDATE';
1947 return $this->selectRowCount( $table, '*', $conds, $fname, $options, $join_conds );
1951 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1952 * It's only slightly flawed. Don't use for anything important.
1954 * @param string $sql A SQL Query
1958 protected static function generalizeSQL( $sql ) {
1959 # This does the same as the regexp below would do, but in such a way
1960 # as to avoid crashing php on some large strings.
1961 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1963 $sql = str_replace( "\\\\", '', $sql );
1964 $sql = str_replace( "\\'", '', $sql );
1965 $sql = str_replace( "\\\"", '', $sql );
1966 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1967 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1969 # All newlines, tabs, etc replaced by single space
1970 $sql = preg_replace( '/\s+/', ' ', $sql );
1973 # except the ones surrounded by characters, e.g. l10n
1974 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1975 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
1980 public function fieldExists( $table, $field, $fname = __METHOD__
) {
1981 $info = $this->fieldInfo( $table, $field );
1986 public function indexExists( $table, $index, $fname = __METHOD__
) {
1987 if ( !$this->tableExists( $table ) ) {
1991 $info = $this->indexInfo( $table, $index, $fname );
1992 if ( is_null( $info ) ) {
1995 return $info !== false;
1999 abstract public function tableExists( $table, $fname = __METHOD__
);
2001 public function indexUnique( $table, $index ) {
2002 $indexInfo = $this->indexInfo( $table, $index );
2004 if ( !$indexInfo ) {
2008 return !$indexInfo[0]->Non_unique
;
2012 * Helper for Database::insert().
2014 * @param array $options
2017 protected function makeInsertOptions( $options ) {
2018 return implode( ' ', $options );
2021 public function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
2022 # No rows to insert, easy just return now
2023 if ( !count( $a ) ) {
2027 $table = $this->tableName( $table );
2029 if ( !is_array( $options ) ) {
2030 $options = [ $options ];
2034 if ( isset( $options['fileHandle'] ) ) {
2035 $fh = $options['fileHandle'];
2037 $options = $this->makeInsertOptions( $options );
2039 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
2041 $keys = array_keys( $a[0] );
2044 $keys = array_keys( $a );
2047 $sql = 'INSERT ' . $options .
2048 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
2052 foreach ( $a as $row ) {
2058 $sql .= '(' . $this->makeList( $row ) . ')';
2061 $sql .= '(' . $this->makeList( $a ) . ')';
2064 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
2066 } elseif ( $fh !== null ) {
2070 return (bool)$this->query( $sql, $fname );
2074 * Make UPDATE options array for Database::makeUpdateOptions
2076 * @param array $options
2079 protected function makeUpdateOptionsArray( $options ) {
2080 if ( !is_array( $options ) ) {
2081 $options = [ $options ];
2086 if ( in_array( 'IGNORE', $options ) ) {
2094 * Make UPDATE options for the Database::update function
2096 * @param array $options The options passed to Database::update
2099 protected function makeUpdateOptions( $options ) {
2100 $opts = $this->makeUpdateOptionsArray( $options );
2102 return implode( ' ', $opts );
2105 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] ) {
2106 $table = $this->tableName( $table );
2107 $opts = $this->makeUpdateOptions( $options );
2108 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self
::LIST_SET
);
2110 if ( $conds !== [] && $conds !== '*' ) {
2111 $sql .= " WHERE " . $this->makeList( $conds, self
::LIST_AND
);
2114 return (bool)$this->query( $sql, $fname );
2117 public function makeList( $a, $mode = self
::LIST_COMMA
) {
2118 if ( !is_array( $a ) ) {
2119 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
2125 foreach ( $a as $field => $value ) {
2127 if ( $mode == self
::LIST_AND
) {
2129 } elseif ( $mode == self
::LIST_OR
) {
2138 if ( ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_numeric( $field ) ) {
2139 $list .= "($value)";
2140 } elseif ( $mode == self
::LIST_SET
&& is_numeric( $field ) ) {
2143 ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_array( $value )
2145 // Remove null from array to be handled separately if found
2146 $includeNull = false;
2147 foreach ( array_keys( $value, null, true ) as $nullKey ) {
2148 $includeNull = true;
2149 unset( $value[$nullKey] );
2151 if ( count( $value ) == 0 && !$includeNull ) {
2152 throw new InvalidArgumentException(
2153 __METHOD__
. ": empty input for field $field" );
2154 } elseif ( count( $value ) == 0 ) {
2155 // only check if $field is null
2156 $list .= "$field IS NULL";
2158 // IN clause contains at least one valid element
2159 if ( $includeNull ) {
2160 // Group subconditions to ensure correct precedence
2163 if ( count( $value ) == 1 ) {
2164 // Special-case single values, as IN isn't terribly efficient
2165 // Don't necessarily assume the single key is 0; we don't
2166 // enforce linear numeric ordering on other arrays here.
2167 $value = array_values( $value )[0];
2168 $list .= $field . " = " . $this->addQuotes( $value );
2170 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
2172 // if null present in array, append IS NULL
2173 if ( $includeNull ) {
2174 $list .= " OR $field IS NULL)";
2177 } elseif ( $value === null ) {
2178 if ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) {
2179 $list .= "$field IS ";
2180 } elseif ( $mode == self
::LIST_SET
) {
2181 $list .= "$field = ";
2186 $mode == self
::LIST_AND ||
$mode == self
::LIST_OR ||
$mode == self
::LIST_SET
2188 $list .= "$field = ";
2190 $list .= $mode == self
::LIST_NAMES ?
$value : $this->addQuotes( $value );
2197 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
2200 foreach ( $data as $base => $sub ) {
2201 if ( count( $sub ) ) {
2202 $conds[] = $this->makeList(
2203 [ $baseKey => $base, $subKey => array_keys( $sub ) ],
2209 return $this->makeList( $conds, self
::LIST_OR
);
2211 // Nothing to search for...
2216 public function aggregateValue( $valuedata, $valuename = 'value' ) {
2220 public function bitNot( $field ) {
2224 public function bitAnd( $fieldLeft, $fieldRight ) {
2225 return "($fieldLeft & $fieldRight)";
2228 public function bitOr( $fieldLeft, $fieldRight ) {
2229 return "($fieldLeft | $fieldRight)";
2232 public function buildConcat( $stringList ) {
2233 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2236 public function buildGroupConcatField(
2237 $delim, $table, $field, $conds = '', $join_conds = []
2239 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
2241 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
2244 public function buildSubstring( $input, $startPosition, $length = null ) {
2245 $this->assertBuildSubstringParams( $startPosition, $length );
2246 $functionBody = "$input FROM $startPosition";
2247 if ( $length !== null ) {
2248 $functionBody .= " FOR $length";
2250 return 'SUBSTRING(' . $functionBody . ')';
2254 * Check type and bounds for parameters to self::buildSubstring()
2256 * All supported databases have substring functions that behave the same for
2257 * positive $startPosition and non-negative $length, but behaviors differ when
2258 * given 0 or negative $startPosition or negative $length. The simplest
2259 * solution to that is to just forbid those values.
2261 * @param int $startPosition
2262 * @param int|null $length
2265 protected function assertBuildSubstringParams( $startPosition, $length ) {
2266 if ( !is_int( $startPosition ) ||
$startPosition <= 0 ) {
2267 throw new InvalidArgumentException(
2268 '$startPosition must be a positive integer'
2271 if ( !( is_int( $length ) && $length >= 0 ||
$length === null ) ) {
2272 throw new InvalidArgumentException(
2273 '$length must be null or an integer greater than or equal to 0'
2278 public function buildStringCast( $field ) {
2282 public function buildIntegerCast( $field ) {
2283 return 'CAST( ' . $field . ' AS INTEGER )';
2286 public function buildSelectSubquery(
2287 $table, $vars, $conds = '', $fname = __METHOD__
,
2288 $options = [], $join_conds = []
2290 return new Subquery(
2291 $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds )
2295 public function databasesAreIndependent() {
2299 final public function selectDB( $db ) {
2300 $this->selectDomain( new DatabaseDomain(
2302 $this->currentDomain
->getSchema(),
2303 $this->currentDomain
->getTablePrefix()
2309 final public function selectDomain( $domain ) {
2310 $this->doSelectDomain( DatabaseDomain
::newFromId( $domain ) );
2313 protected function doSelectDomain( DatabaseDomain
$domain ) {
2314 $this->currentDomain
= $domain;
2317 public function getDBname() {
2318 return $this->currentDomain
->getDatabase();
2321 public function getServer() {
2322 return $this->server
;
2325 public function tableName( $name, $format = 'quoted' ) {
2326 if ( $name instanceof Subquery
) {
2327 throw new DBUnexpectedError(
2329 __METHOD__
. ': got Subquery instance when expecting a string.'
2333 # Skip the entire process when we have a string quoted on both ends.
2334 # Note that we check the end so that we will still quote any use of
2335 # use of `database`.table. But won't break things if someone wants
2336 # to query a database table with a dot in the name.
2337 if ( $this->isQuotedIdentifier( $name ) ) {
2341 # Lets test for any bits of text that should never show up in a table
2342 # name. Basically anything like JOIN or ON which are actually part of
2343 # SQL queries, but may end up inside of the table value to combine
2344 # sql. Such as how the API is doing.
2345 # Note that we use a whitespace test rather than a \b test to avoid
2346 # any remote case where a word like on may be inside of a table name
2347 # surrounded by symbols which may be considered word breaks.
2348 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2349 $this->queryLogger
->warning(
2350 __METHOD__
. ": use of subqueries is not supported this way.",
2351 [ 'trace' => ( new RuntimeException() )->getTraceAsString() ]
2357 # Split database and table into proper variables.
2358 list( $database, $schema, $prefix, $table ) = $this->qualifiedTableComponents( $name );
2360 # Quote $table and apply the prefix if not quoted.
2361 # $tableName might be empty if this is called from Database::replaceVars()
2362 $tableName = "{$prefix}{$table}";
2363 if ( $format === 'quoted'
2364 && !$this->isQuotedIdentifier( $tableName )
2365 && $tableName !== ''
2367 $tableName = $this->addIdentifierQuotes( $tableName );
2370 # Quote $schema and $database and merge them with the table name if needed
2371 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
2372 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
2378 * Get the table components needed for a query given the currently selected database
2380 * @param string $name Table name in the form of db.schema.table, db.table, or table
2381 * @return array (DB name or "" for default, schema name, table prefix, table name)
2383 protected function qualifiedTableComponents( $name ) {
2384 # We reverse the explode so that database.table and table both output the correct table.
2385 $dbDetails = explode( '.', $name, 3 );
2386 if ( count( $dbDetails ) == 3 ) {
2387 list( $database, $schema, $table ) = $dbDetails;
2388 # We don't want any prefix added in this case
2390 } elseif ( count( $dbDetails ) == 2 ) {
2391 list( $database, $table ) = $dbDetails;
2392 # We don't want any prefix added in this case
2394 # In dbs that support it, $database may actually be the schema
2395 # but that doesn't affect any of the functionality here
2398 list( $table ) = $dbDetails;
2399 if ( isset( $this->tableAliases
[$table] ) ) {
2400 $database = $this->tableAliases
[$table]['dbname'];
2401 $schema = is_string( $this->tableAliases
[$table]['schema'] )
2402 ?
$this->tableAliases
[$table]['schema']
2403 : $this->relationSchemaQualifier();
2404 $prefix = is_string( $this->tableAliases
[$table]['prefix'] )
2405 ?
$this->tableAliases
[$table]['prefix']
2406 : $this->tablePrefix();
2409 $schema = $this->relationSchemaQualifier(); # Default schema
2410 $prefix = $this->tablePrefix(); # Default prefix
2414 return [ $database, $schema, $prefix, $table ];
2418 * @param string|null $namespace Database or schema
2419 * @param string $relation Name of table, view, sequence, etc...
2420 * @param string $format One of (raw, quoted)
2421 * @return string Relation name with quoted and merged $namespace as needed
2423 private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
2424 if ( strlen( $namespace ) ) {
2425 if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
2426 $namespace = $this->addIdentifierQuotes( $namespace );
2428 $relation = $namespace . '.' . $relation;
2434 public function tableNames() {
2435 $inArray = func_get_args();
2438 foreach ( $inArray as $name ) {
2439 $retVal[$name] = $this->tableName( $name );
2445 public function tableNamesN() {
2446 $inArray = func_get_args();
2449 foreach ( $inArray as $name ) {
2450 $retVal[] = $this->tableName( $name );
2457 * Get an aliased table name
2459 * This returns strings like "tableName AS newTableName" for aliased tables
2460 * and "(SELECT * from tableA) newTablename" for subqueries (e.g. derived tables)
2462 * @see Database::tableName()
2463 * @param string|Subquery $table Table name or object with a 'sql' field
2464 * @param string|bool $alias Table alias (optional)
2465 * @return string SQL name for aliased table. Will not alias a table to its own name
2467 protected function tableNameWithAlias( $table, $alias = false ) {
2468 if ( is_string( $table ) ) {
2469 $quotedTable = $this->tableName( $table );
2470 } elseif ( $table instanceof Subquery
) {
2471 $quotedTable = (string)$table;
2473 throw new InvalidArgumentException( "Table must be a string or Subquery." );
2476 if ( !strlen( $alias ) ||
$alias === $table ) {
2477 if ( $table instanceof Subquery
) {
2478 throw new InvalidArgumentException( "Subquery table missing alias." );
2481 return $quotedTable;
2483 return $quotedTable . ' ' . $this->addIdentifierQuotes( $alias );
2488 * Gets an array of aliased table names
2490 * @param array $tables [ [alias] => table ]
2491 * @return string[] See tableNameWithAlias()
2493 protected function tableNamesWithAlias( $tables ) {
2495 foreach ( $tables as $alias => $table ) {
2496 if ( is_numeric( $alias ) ) {
2499 $retval[] = $this->tableNameWithAlias( $table, $alias );
2506 * Get an aliased field name
2507 * e.g. fieldName AS newFieldName
2509 * @param string $name Field name
2510 * @param string|bool $alias Alias (optional)
2511 * @return string SQL name for aliased field. Will not alias a field to its own name
2513 protected function fieldNameWithAlias( $name, $alias = false ) {
2514 if ( !$alias ||
(string)$alias === (string)$name ) {
2517 return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
2522 * Gets an array of aliased field names
2524 * @param array $fields [ [alias] => field ]
2525 * @return string[] See fieldNameWithAlias()
2527 protected function fieldNamesWithAlias( $fields ) {
2529 foreach ( $fields as $alias => $field ) {
2530 if ( is_numeric( $alias ) ) {
2533 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2540 * Get the aliased table name clause for a FROM clause
2541 * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
2543 * @param array $tables ( [alias] => table )
2544 * @param array $use_index Same as for select()
2545 * @param array $ignore_index Same as for select()
2546 * @param array $join_conds Same as for select()
2549 protected function tableNamesWithIndexClauseOrJOIN(
2550 $tables, $use_index = [], $ignore_index = [], $join_conds = []
2554 $use_index = (array)$use_index;
2555 $ignore_index = (array)$ignore_index;
2556 $join_conds = (array)$join_conds;
2558 foreach ( $tables as $alias => $table ) {
2559 if ( !is_string( $alias ) ) {
2560 // No alias? Set it equal to the table name
2564 if ( is_array( $table ) ) {
2565 // A parenthesized group
2566 if ( count( $table ) > 1 ) {
2567 $joinedTable = '(' .
2568 $this->tableNamesWithIndexClauseOrJOIN(
2569 $table, $use_index, $ignore_index, $join_conds ) . ')';
2572 $innerTable = reset( $table );
2573 $innerAlias = key( $table );
2574 $joinedTable = $this->tableNameWithAlias(
2576 is_string( $innerAlias ) ?
$innerAlias : $innerTable
2580 $joinedTable = $this->tableNameWithAlias( $table, $alias );
2583 // Is there a JOIN clause for this table?
2584 if ( isset( $join_conds[$alias] ) ) {
2585 list( $joinType, $conds ) = $join_conds[$alias];
2586 $tableClause = $joinType;
2587 $tableClause .= ' ' . $joinedTable;
2588 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2589 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2591 $tableClause .= ' ' . $use;
2594 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
2595 $ignore = $this->ignoreIndexClause(
2596 implode( ',', (array)$ignore_index[$alias] ) );
2597 if ( $ignore != '' ) {
2598 $tableClause .= ' ' . $ignore;
2601 $on = $this->makeList( (array)$conds, self
::LIST_AND
);
2603 $tableClause .= ' ON (' . $on . ')';
2606 $retJOIN[] = $tableClause;
2607 } elseif ( isset( $use_index[$alias] ) ) {
2608 // Is there an INDEX clause for this table?
2609 $tableClause = $joinedTable;
2610 $tableClause .= ' ' . $this->useIndexClause(
2611 implode( ',', (array)$use_index[$alias] )
2614 $ret[] = $tableClause;
2615 } elseif ( isset( $ignore_index[$alias] ) ) {
2616 // Is there an INDEX clause for this table?
2617 $tableClause = $joinedTable;
2618 $tableClause .= ' ' . $this->ignoreIndexClause(
2619 implode( ',', (array)$ignore_index[$alias] )
2622 $ret[] = $tableClause;
2624 $tableClause = $joinedTable;
2626 $ret[] = $tableClause;
2630 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2631 $implicitJoins = $ret ?
implode( ',', $ret ) : "";
2632 $explicitJoins = $retJOIN ?
implode( ' ', $retJOIN ) : "";
2634 // Compile our final table clause
2635 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
2639 * Allows for index remapping in queries where this is not consistent across DBMS
2641 * @param string $index
2644 protected function indexName( $index ) {
2645 return $this->indexAliases
[$index] ??
$index;
2648 public function addQuotes( $s ) {
2649 if ( $s instanceof Blob
) {
2652 if ( $s === null ) {
2654 } elseif ( is_bool( $s ) ) {
2657 # This will also quote numeric values. This should be harmless,
2658 # and protects against weird problems that occur when they really
2659 # _are_ strings such as article titles and string->number->string
2660 # conversion is not 1:1.
2661 return "'" . $this->strencode( $s ) . "'";
2666 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2667 * MySQL uses `backticks` while basically everything else uses double quotes.
2668 * Since MySQL is the odd one out here the double quotes are our generic
2669 * and we implement backticks in DatabaseMysqlBase.
2674 public function addIdentifierQuotes( $s ) {
2675 return '"' . str_replace( '"', '""', $s ) . '"';
2679 * Returns if the given identifier looks quoted or not according to
2680 * the database convention for quoting identifiers .
2682 * @note Do not use this to determine if untrusted input is safe.
2683 * A malicious user can trick this function.
2684 * @param string $name
2687 public function isQuotedIdentifier( $name ) {
2688 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2693 * @param string $escapeChar
2696 protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2697 return str_replace( [ $escapeChar, '%', '_' ],
2698 [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2702 public function buildLike() {
2703 $params = func_get_args();
2705 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2706 $params = $params[0];
2711 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2712 // may escape backslashes, creating problems of double escaping. The `
2713 // character has good cross-DBMS compatibility, avoiding special operators
2714 // in MS SQL like ^ and %
2717 foreach ( $params as $value ) {
2718 if ( $value instanceof LikeMatch
) {
2719 $s .= $value->toString();
2721 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2726 $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2729 public function anyChar() {
2730 return new LikeMatch( '_' );
2733 public function anyString() {
2734 return new LikeMatch( '%' );
2737 public function nextSequenceValue( $seqName ) {
2742 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2743 * is only needed because a) MySQL must be as efficient as possible due to
2744 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2745 * which index to pick. Anyway, other databases might have different
2746 * indexes on a given table. So don't bother overriding this unless you're
2748 * @param string $index
2751 public function useIndexClause( $index ) {
2756 * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2757 * is only needed because a) MySQL must be as efficient as possible due to
2758 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2759 * which index to pick. Anyway, other databases might have different
2760 * indexes on a given table. So don't bother overriding this unless you're
2762 * @param string $index
2765 public function ignoreIndexClause( $index ) {
2769 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
2770 if ( count( $rows ) == 0 ) {
2775 if ( !is_array( reset( $rows ) ) ) {
2780 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2781 $affectedRowCount = 0;
2782 foreach ( $rows as $row ) {
2783 // Delete rows which collide with this one
2784 $indexWhereClauses = [];
2785 foreach ( $uniqueIndexes as $index ) {
2786 $indexColumns = (array)$index;
2787 $indexRowValues = array_intersect_key( $row, array_flip( $indexColumns ) );
2788 if ( count( $indexRowValues ) != count( $indexColumns ) ) {
2789 throw new DBUnexpectedError(
2791 'New record does not provide all values for unique key (' .
2792 implode( ', ', $indexColumns ) . ')'
2794 } elseif ( in_array( null, $indexRowValues, true ) ) {
2795 throw new DBUnexpectedError(
2797 'New record has a null value for unique key (' .
2798 implode( ', ', $indexColumns ) . ')'
2801 $indexWhereClauses[] = $this->makeList( $indexRowValues, LIST_AND
);
2804 if ( $indexWhereClauses ) {
2805 $this->delete( $table, $this->makeList( $indexWhereClauses, LIST_OR
), $fname );
2806 $affectedRowCount +
= $this->affectedRows();
2809 // Now insert the row
2810 $this->insert( $table, $row, $fname );
2811 $affectedRowCount +
= $this->affectedRows();
2813 $this->endAtomic( $fname );
2814 $this->affectedRowCount
= $affectedRowCount;
2815 } catch ( Exception
$e ) {
2816 $this->cancelAtomic( $fname );
2822 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2825 * @param string $table Table name
2826 * @param array|string $rows Row(s) to insert
2827 * @param string $fname Caller function name
2829 * @return ResultWrapper
2831 protected function nativeReplace( $table, $rows, $fname ) {
2832 $table = $this->tableName( $table );
2835 if ( !is_array( reset( $rows ) ) ) {
2839 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2842 foreach ( $rows as $row ) {
2849 $sql .= '(' . $this->makeList( $row ) . ')';
2852 return $this->query( $sql, $fname );
2855 public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2858 if ( !count( $rows ) ) {
2859 return true; // nothing to do
2862 if ( !is_array( reset( $rows ) ) ) {
2866 if ( count( $uniqueIndexes ) ) {
2867 $clauses = []; // list WHERE clauses that each identify a single row
2868 foreach ( $rows as $row ) {
2869 foreach ( $uniqueIndexes as $index ) {
2870 $index = is_array( $index ) ?
$index : [ $index ]; // columns
2871 $rowKey = []; // unique key to this row
2872 foreach ( $index as $column ) {
2873 $rowKey[$column] = $row[$column];
2875 $clauses[] = $this->makeList( $rowKey, self
::LIST_AND
);
2878 $where = [ $this->makeList( $clauses, self
::LIST_OR
) ];
2883 $affectedRowCount = 0;
2885 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2886 # Update any existing conflicting row(s)
2887 if ( $where !== false ) {
2888 $ok = $this->update( $table, $set, $where, $fname );
2889 $affectedRowCount +
= $this->affectedRows();
2893 # Now insert any non-conflicting row(s)
2894 $ok = $this->insert( $table, $rows, $fname, [ 'IGNORE' ] ) && $ok;
2895 $affectedRowCount +
= $this->affectedRows();
2896 $this->endAtomic( $fname );
2897 $this->affectedRowCount
= $affectedRowCount;
2898 } catch ( Exception
$e ) {
2899 $this->cancelAtomic( $fname );
2906 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2910 throw new DBUnexpectedError( $this, __METHOD__
. ' called with empty $conds' );
2913 $delTable = $this->tableName( $delTable );
2914 $joinTable = $this->tableName( $joinTable );
2915 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2916 if ( $conds != '*' ) {
2917 $sql .= 'WHERE ' . $this->makeList( $conds, self
::LIST_AND
);
2921 $this->query( $sql, $fname );
2924 public function textFieldSize( $table, $field ) {
2925 $table = $this->tableName( $table );
2926 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2927 $res = $this->query( $sql, __METHOD__
);
2928 $row = $this->fetchObject( $res );
2932 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
2941 public function delete( $table, $conds, $fname = __METHOD__
) {
2943 throw new DBUnexpectedError( $this, __METHOD__
. ' called with no conditions' );
2946 $table = $this->tableName( $table );
2947 $sql = "DELETE FROM $table";
2949 if ( $conds != '*' ) {
2950 if ( is_array( $conds ) ) {
2951 $conds = $this->makeList( $conds, self
::LIST_AND
);
2953 $sql .= ' WHERE ' . $conds;
2956 return $this->query( $sql, $fname );
2959 final public function insertSelect(
2960 $destTable, $srcTable, $varMap, $conds,
2961 $fname = __METHOD__
, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2963 static $hints = [ 'NO_AUTO_COLUMNS' ];
2965 $insertOptions = (array)$insertOptions;
2966 $selectOptions = (array)$selectOptions;
2968 if ( $this->cliMode
&& $this->isInsertSelectSafe( $insertOptions, $selectOptions ) ) {
2969 // For massive migrations with downtime, we don't want to select everything
2970 // into memory and OOM, so do all this native on the server side if possible.
2971 return $this->nativeInsertSelect(
2977 array_diff( $insertOptions, $hints ),
2983 return $this->nonNativeInsertSelect(
2989 array_diff( $insertOptions, $hints ),
2996 * @param array $insertOptions INSERT options
2997 * @param array $selectOptions SELECT options
2998 * @return bool Whether an INSERT SELECT with these options will be replication safe
3001 protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
3006 * Implementation of insertSelect() based on select() and insert()
3008 * @see IDatabase::insertSelect()
3010 * @param string $destTable
3011 * @param string|array $srcTable
3012 * @param array $varMap
3013 * @param array $conds
3014 * @param string $fname
3015 * @param array $insertOptions
3016 * @param array $selectOptions
3017 * @param array $selectJoinConds
3020 protected function nonNativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3021 $fname = __METHOD__
,
3022 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3024 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
3025 // on only the master (without needing row-based-replication). It also makes it easy to
3026 // know how big the INSERT is going to be.
3028 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
3029 $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
3031 $selectOptions[] = 'FOR UPDATE';
3032 $res = $this->select(
3033 $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions, $selectJoinConds
3040 $affectedRowCount = 0;
3041 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
3044 foreach ( $res as $row ) {
3045 $rows[] = (array)$row;
3047 // Avoid inserts that are too huge
3048 if ( count( $rows ) >= $this->nonNativeInsertSelectBatchSize
) {
3049 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3053 $affectedRowCount +
= $this->affectedRows();
3057 if ( $rows && $ok ) {
3058 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3060 $affectedRowCount +
= $this->affectedRows();
3064 $this->endAtomic( $fname );
3065 $this->affectedRowCount
= $affectedRowCount;
3067 $this->cancelAtomic( $fname );
3070 } catch ( Exception
$e ) {
3071 $this->cancelAtomic( $fname );
3077 * Native server-side implementation of insertSelect() for situations where
3078 * we don't want to select everything into memory
3080 * @see IDatabase::insertSelect()
3081 * @param string $destTable
3082 * @param string|array $srcTable
3083 * @param array $varMap
3084 * @param array $conds
3085 * @param string $fname
3086 * @param array $insertOptions
3087 * @param array $selectOptions
3088 * @param array $selectJoinConds
3091 protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3092 $fname = __METHOD__
,
3093 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3095 $destTable = $this->tableName( $destTable );
3097 if ( !is_array( $insertOptions ) ) {
3098 $insertOptions = [ $insertOptions ];
3101 $insertOptions = $this->makeInsertOptions( $insertOptions );
3103 $selectSql = $this->selectSQLText(
3105 array_values( $varMap ),
3112 $sql = "INSERT $insertOptions" .
3113 " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
3116 return $this->query( $sql, $fname );
3120 * Construct a LIMIT query with optional offset. This is used for query
3121 * pages. The SQL should be adjusted so that only the first $limit rows
3122 * are returned. If $offset is provided as well, then the first $offset
3123 * rows should be discarded, and the next $limit rows should be returned.
3124 * If the result of the query is not ordered, then the rows to be returned
3125 * are theoretically arbitrary.
3127 * $sql is expected to be a SELECT, if that makes a difference.
3129 * The version provided by default works in MySQL and SQLite. It will very
3130 * likely need to be overridden for most other DBMSes.
3132 * @param string $sql SQL query we will append the limit too
3133 * @param int $limit The SQL limit
3134 * @param int|bool $offset The SQL offset (default false)
3135 * @throws DBUnexpectedError
3138 public function limitResult( $sql, $limit, $offset = false ) {
3139 if ( !is_numeric( $limit ) ) {
3140 throw new DBUnexpectedError( $this,
3141 "Invalid non-numeric limit passed to limitResult()\n" );
3144 return "$sql LIMIT "
3145 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
3149 public function unionSupportsOrderAndLimit() {
3150 return true; // True for almost every DB supported
3153 public function unionQueries( $sqls, $all ) {
3154 $glue = $all ?
') UNION ALL (' : ') UNION (';
3156 return '(' . implode( $glue, $sqls ) . ')';
3159 public function unionConditionPermutations(
3160 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
3161 $options = [], $join_conds = []
3163 // First, build the Cartesian product of $permute_conds
3165 foreach ( $permute_conds as $field => $values ) {
3167 // Skip empty $values
3170 $values = array_unique( $values ); // For sanity
3172 foreach ( $conds as $cond ) {
3173 foreach ( $values as $value ) {
3174 $cond[$field] = $value;
3175 $newConds[] = $cond; // Arrays are by-value, not by-reference, so this works
3181 $extra_conds = $extra_conds === '' ?
[] : (array)$extra_conds;
3183 // If there's just one condition and no subordering, hand off to
3184 // selectSQLText directly.
3185 if ( count( $conds ) === 1 &&
3186 ( !isset( $options['INNER ORDER BY'] ) ||
!$this->unionSupportsOrderAndLimit() )
3188 return $this->selectSQLText(
3189 $table, $vars, $conds[0] +
$extra_conds, $fname, $options, $join_conds
3193 // Otherwise, we need to pull out the order and limit to apply after
3194 // the union. Then build the SQL queries for each set of conditions in
3195 // $conds. Then union them together (using UNION ALL, because the
3196 // product *should* already be distinct).
3197 $orderBy = $this->makeOrderBy( $options );
3198 $limit = $options['LIMIT'] ??
null;
3199 $offset = $options['OFFSET'] ??
false;
3200 $all = empty( $options['NOTALL'] ) && !in_array( 'NOTALL', $options );
3201 if ( !$this->unionSupportsOrderAndLimit() ) {
3202 unset( $options['ORDER BY'], $options['LIMIT'], $options['OFFSET'] );
3204 if ( array_key_exists( 'INNER ORDER BY', $options ) ) {
3205 $options['ORDER BY'] = $options['INNER ORDER BY'];
3207 if ( $limit !== null && is_numeric( $offset ) && $offset != 0 ) {
3208 // We need to increase the limit by the offset rather than
3209 // using the offset directly, otherwise it'll skip incorrectly
3210 // in the subqueries.
3211 $options['LIMIT'] = $limit +
$offset;
3212 unset( $options['OFFSET'] );
3217 foreach ( $conds as $cond ) {
3218 $sqls[] = $this->selectSQLText(
3219 $table, $vars, $cond +
$extra_conds, $fname, $options, $join_conds
3222 $sql = $this->unionQueries( $sqls, $all ) . $orderBy;
3223 if ( $limit !== null ) {
3224 $sql = $this->limitResult( $sql, $limit, $offset );
3230 public function conditional( $cond, $trueVal, $falseVal ) {
3231 if ( is_array( $cond ) ) {
3232 $cond = $this->makeList( $cond, self
::LIST_AND
);
3235 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
3238 public function strreplace( $orig, $old, $new ) {
3239 return "REPLACE({$orig}, {$old}, {$new})";
3242 public function getServerUptime() {
3246 public function wasDeadlock() {
3250 public function wasLockTimeout() {
3254 public function wasConnectionLoss() {
3255 return $this->wasConnectionError( $this->lastErrno() );
3258 public function wasReadOnlyError() {
3262 public function wasErrorReissuable() {
3264 $this->wasDeadlock() ||
3265 $this->wasLockTimeout() ||
3266 $this->wasConnectionLoss()
3271 * Do not use this method outside of Database/DBError classes
3273 * @param int|string $errno
3274 * @return bool Whether the given query error was a connection drop
3276 public function wasConnectionError( $errno ) {
3281 * @return bool Whether it is safe to assume the given error only caused statement rollback
3282 * @note This is for backwards compatibility for callers catching DBError exceptions in
3283 * order to ignore problems like duplicate key errors or foriegn key violations
3286 protected function wasKnownStatementRollbackError() {
3287 return false; // don't know; it could have caused a transaction rollback
3290 public function deadlockLoop() {
3291 $args = func_get_args();
3292 $function = array_shift( $args );
3293 $tries = self
::DEADLOCK_TRIES
;
3295 $this->begin( __METHOD__
);
3298 /** @var Exception $e */
3302 $retVal = $function( ...$args );
3304 } catch ( DBQueryError
$e ) {
3305 if ( $this->wasDeadlock() ) {
3306 // Retry after a randomized delay
3307 usleep( mt_rand( self
::DEADLOCK_DELAY_MIN
, self
::DEADLOCK_DELAY_MAX
) );
3309 // Throw the error back up
3313 } while ( --$tries > 0 );
3315 if ( $tries <= 0 ) {
3316 // Too many deadlocks; give up
3317 $this->rollback( __METHOD__
);
3320 $this->commit( __METHOD__
);
3326 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
3327 # Real waits are implemented in the subclass.
3331 public function getReplicaPos() {
3336 public function getMasterPos() {
3341 public function serverIsReadOnly() {
3345 final public function onTransactionResolution( callable
$callback, $fname = __METHOD__
) {
3346 if ( !$this->trxLevel
) {
3347 throw new DBUnexpectedError( $this, "No transaction is active." );
3349 $this->trxEndCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3352 final public function onTransactionCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
3353 if ( !$this->trxLevel
&& $this->getTransactionRoundId() ) {
3354 // Start an implicit transaction similar to how query() does
3355 $this->begin( __METHOD__
, self
::TRANSACTION_INTERNAL
);
3356 $this->trxAutomatic
= true;
3359 $this->trxIdleCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3360 if ( !$this->trxLevel
) {
3361 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_IDLE
);
3365 final public function onTransactionIdle( callable
$callback, $fname = __METHOD__
) {
3366 $this->onTransactionCommitOrIdle( $callback, $fname );
3369 final public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
3370 if ( !$this->trxLevel
&& $this->getTransactionRoundId() ) {
3371 // Start an implicit transaction similar to how query() does
3372 $this->begin( __METHOD__
, self
::TRANSACTION_INTERNAL
);
3373 $this->trxAutomatic
= true;
3376 if ( $this->trxLevel
) {
3377 $this->trxPreCommitCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3379 // No transaction is active nor will start implicitly, so make one for this callback
3380 $this->startAtomic( __METHOD__
, self
::ATOMIC_CANCELABLE
);
3383 $this->endAtomic( __METHOD__
);
3384 } catch ( Exception
$e ) {
3385 $this->cancelAtomic( __METHOD__
);
3392 * @return AtomicSectionIdentifier|null ID of the topmost atomic section level
3394 private function currentAtomicSectionId() {
3395 if ( $this->trxLevel
&& $this->trxAtomicLevels
) {
3396 $levelInfo = end( $this->trxAtomicLevels
);
3398 return $levelInfo[1];
3405 * @param AtomicSectionIdentifier $old
3406 * @param AtomicSectionIdentifier $new
3408 private function reassignCallbacksForSection(
3409 AtomicSectionIdentifier
$old, AtomicSectionIdentifier
$new
3411 foreach ( $this->trxPreCommitCallbacks
as $key => $info ) {
3412 if ( $info[2] === $old ) {
3413 $this->trxPreCommitCallbacks
[$key][2] = $new;
3416 foreach ( $this->trxIdleCallbacks
as $key => $info ) {
3417 if ( $info[2] === $old ) {
3418 $this->trxIdleCallbacks
[$key][2] = $new;
3421 foreach ( $this->trxEndCallbacks
as $key => $info ) {
3422 if ( $info[2] === $old ) {
3423 $this->trxEndCallbacks
[$key][2] = $new;
3429 * @param AtomicSectionIdentifier[] $sectionIds ID of an actual savepoint
3430 * @throws UnexpectedValueException
3432 private function modifyCallbacksForCancel( array $sectionIds ) {
3433 // Cancel the "on commit" callbacks owned by this savepoint
3434 $this->trxIdleCallbacks
= array_filter(
3435 $this->trxIdleCallbacks
,
3436 function ( $entry ) use ( $sectionIds ) {
3437 return !in_array( $entry[2], $sectionIds, true );
3440 $this->trxPreCommitCallbacks
= array_filter(
3441 $this->trxPreCommitCallbacks
,
3442 function ( $entry ) use ( $sectionIds ) {
3443 return !in_array( $entry[2], $sectionIds, true );
3446 // Make "on resolution" callbacks owned by this savepoint to perceive a rollback
3447 foreach ( $this->trxEndCallbacks
as $key => $entry ) {
3448 if ( in_array( $entry[2], $sectionIds, true ) ) {
3449 $callback = $entry[0];
3450 $this->trxEndCallbacks
[$key][0] = function () use ( $callback ) {
3451 return $callback( self
::TRIGGER_ROLLBACK
, $this );
3457 final public function setTransactionListener( $name, callable
$callback = null ) {
3459 $this->trxRecurringCallbacks
[$name] = $callback;
3461 unset( $this->trxRecurringCallbacks
[$name] );
3466 * Whether to disable running of post-COMMIT/ROLLBACK callbacks
3468 * This method should not be used outside of Database/LoadBalancer
3470 * @param bool $suppress
3473 final public function setTrxEndCallbackSuppression( $suppress ) {
3474 $this->trxEndCallbacksSuppressed
= $suppress;
3478 * Actually consume and run any "on transaction idle/resolution" callbacks.
3480 * This method should not be used outside of Database/LoadBalancer
3482 * @param int $trigger IDatabase::TRIGGER_* constant
3483 * @return int Number of callbacks attempted
3487 public function runOnTransactionIdleCallbacks( $trigger ) {
3488 if ( $this->trxLevel
) { // sanity
3489 throw new DBUnexpectedError( $this, __METHOD__
. ': a transaction is still open.' );
3492 if ( $this->trxEndCallbacksSuppressed
) {
3497 $autoTrx = $this->getFlag( self
::DBO_TRX
); // automatic begin() enabled?
3498 /** @var Exception $e */
3499 $e = null; // first exception
3500 do { // callbacks may add callbacks :)
3501 $callbacks = array_merge(
3502 $this->trxIdleCallbacks
,
3503 $this->trxEndCallbacks
// include "transaction resolution" callbacks
3505 $this->trxIdleCallbacks
= []; // consumed (and recursion guard)
3506 $this->trxEndCallbacks
= []; // consumed (recursion guard)
3507 foreach ( $callbacks as $callback ) {
3509 list( $phpCallback ) = $callback;
3510 $this->clearFlag( self
::DBO_TRX
); // make each query its own transaction
3512 call_user_func( $phpCallback, $trigger, $this );
3513 } catch ( Exception
$ex ) {
3514 call_user_func( $this->errorLogger
, $ex );
3516 // Some callbacks may use startAtomic/endAtomic, so make sure
3517 // their transactions are ended so other callbacks don't fail
3518 if ( $this->trxLevel() ) {
3519 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
3523 $this->setFlag( self
::DBO_TRX
); // restore automatic begin()
3525 $this->clearFlag( self
::DBO_TRX
); // restore auto-commit
3529 } while ( count( $this->trxIdleCallbacks
) );
3531 if ( $e instanceof Exception
) {
3532 throw $e; // re-throw any first exception
3539 * Actually consume and run any "on transaction pre-commit" callbacks.
3541 * This method should not be used outside of Database/LoadBalancer
3544 * @return int Number of callbacks attempted
3547 public function runOnTransactionPreCommitCallbacks() {
3550 $e = null; // first exception
3551 do { // callbacks may add callbacks :)
3552 $callbacks = $this->trxPreCommitCallbacks
;
3553 $this->trxPreCommitCallbacks
= []; // consumed (and recursion guard)
3554 foreach ( $callbacks as $callback ) {
3557 list( $phpCallback ) = $callback;
3558 $phpCallback( $this );
3559 } catch ( Exception
$ex ) {
3560 ( $this->errorLogger
)( $ex );
3564 } while ( count( $this->trxPreCommitCallbacks
) );
3566 if ( $e instanceof Exception
) {
3567 throw $e; // re-throw any first exception
3574 * Actually run any "transaction listener" callbacks.
3576 * This method should not be used outside of Database/LoadBalancer
3578 * @param int $trigger IDatabase::TRIGGER_* constant
3582 public function runTransactionListenerCallbacks( $trigger ) {
3583 if ( $this->trxEndCallbacksSuppressed
) {
3587 /** @var Exception $e */
3588 $e = null; // first exception
3590 foreach ( $this->trxRecurringCallbacks
as $phpCallback ) {
3592 $phpCallback( $trigger, $this );
3593 } catch ( Exception
$ex ) {
3594 ( $this->errorLogger
)( $ex );
3599 if ( $e instanceof Exception
) {
3600 throw $e; // re-throw any first exception
3605 * Create a savepoint
3607 * This is used internally to implement atomic sections. It should not be
3611 * @param string $identifier Identifier for the savepoint
3612 * @param string $fname Calling function name
3614 protected function doSavepoint( $identifier, $fname ) {
3615 $this->query( 'SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3619 * Release a savepoint
3621 * This is used internally to implement atomic sections. It should not be
3625 * @param string $identifier Identifier for the savepoint
3626 * @param string $fname Calling function name
3628 protected function doReleaseSavepoint( $identifier, $fname ) {
3629 $this->query( 'RELEASE SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3633 * Rollback to a savepoint
3635 * This is used internally to implement atomic sections. It should not be
3639 * @param string $identifier Identifier for the savepoint
3640 * @param string $fname Calling function name
3642 protected function doRollbackToSavepoint( $identifier, $fname ) {
3643 $this->query( 'ROLLBACK TO SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3647 * @param string $fname
3650 private function nextSavepointId( $fname ) {
3651 $savepointId = self
::$SAVEPOINT_PREFIX . ++
$this->trxAtomicCounter
;
3652 if ( strlen( $savepointId ) > 30 ) {
3653 // 30 == Oracle's identifier length limit (pre 12c)
3654 // With a 22 character prefix, that puts the highest number at 99999999.
3655 throw new DBUnexpectedError(
3657 'There have been an excessively large number of atomic sections in a transaction'
3658 . " started by $this->trxFname (at $fname)"
3662 return $savepointId;
3665 final public function startAtomic(
3666 $fname = __METHOD__
, $cancelable = self
::ATOMIC_NOT_CANCELABLE
3668 $savepointId = $cancelable === self
::ATOMIC_CANCELABLE ? self
::$NOT_APPLICABLE : null;
3670 if ( !$this->trxLevel
) {
3671 $this->begin( $fname, self
::TRANSACTION_INTERNAL
); // sets trxAutomatic
3672 // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
3673 // in all changes being in one transaction to keep requests transactional.
3674 if ( $this->getFlag( self
::DBO_TRX
) ) {
3675 // Since writes could happen in between the topmost atomic sections as part
3676 // of the transaction, those sections will need savepoints.
3677 $savepointId = $this->nextSavepointId( $fname );
3678 $this->doSavepoint( $savepointId, $fname );
3680 $this->trxAutomaticAtomic
= true;
3682 } elseif ( $cancelable === self
::ATOMIC_CANCELABLE
) {
3683 $savepointId = $this->nextSavepointId( $fname );
3684 $this->doSavepoint( $savepointId, $fname );
3687 $sectionId = new AtomicSectionIdentifier
;
3688 $this->trxAtomicLevels
[] = [ $fname, $sectionId, $savepointId ];
3689 $this->queryLogger
->debug( 'startAtomic: entering level ' .
3690 ( count( $this->trxAtomicLevels
) - 1 ) . " ($fname)" );
3695 final public function endAtomic( $fname = __METHOD__
) {
3696 if ( !$this->trxLevel ||
!$this->trxAtomicLevels
) {
3697 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3700 // Check if the current section matches $fname
3701 $pos = count( $this->trxAtomicLevels
) - 1;
3702 list( $savedFname, $sectionId, $savepointId ) = $this->trxAtomicLevels
[$pos];
3703 $this->queryLogger
->debug( "endAtomic: leaving level $pos ($fname)" );
3705 if ( $savedFname !== $fname ) {
3706 throw new DBUnexpectedError(
3708 "Invalid atomic section ended (got $fname but expected $savedFname)."
3712 // Remove the last section (no need to re-index the array)
3713 array_pop( $this->trxAtomicLevels
);
3715 if ( !$this->trxAtomicLevels
&& $this->trxAutomaticAtomic
) {
3716 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
3717 } elseif ( $savepointId !== null && $savepointId !== self
::$NOT_APPLICABLE ) {
3718 $this->doReleaseSavepoint( $savepointId, $fname );
3721 // Hoist callback ownership for callbacks in the section that just ended;
3722 // all callbacks should have an owner that is present in trxAtomicLevels.
3723 $currentSectionId = $this->currentAtomicSectionId();
3724 if ( $currentSectionId ) {
3725 $this->reassignCallbacksForSection( $sectionId, $currentSectionId );
3729 final public function cancelAtomic(
3730 $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null
3732 if ( !$this->trxLevel ||
!$this->trxAtomicLevels
) {
3733 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3736 $excisedFnames = [];
3737 if ( $sectionId !== null ) {
3738 // Find the (last) section with the given $sectionId
3740 foreach ( $this->trxAtomicLevels
as $i => list( $asFname, $asId, $spId ) ) {
3741 if ( $asId === $sectionId ) {
3746 throw new DBUnexpectedError( "Atomic section not found (for $fname)" );
3748 // Remove all descendant sections and re-index the array
3750 $len = count( $this->trxAtomicLevels
);
3751 for ( $i = $pos +
1; $i < $len; ++
$i ) {
3752 $excisedFnames[] = $this->trxAtomicLevels
[$i][0];
3753 $excisedIds[] = $this->trxAtomicLevels
[$i][1];
3755 $this->trxAtomicLevels
= array_slice( $this->trxAtomicLevels
, 0, $pos +
1 );
3756 $this->modifyCallbacksForCancel( $excisedIds );
3759 // Check if the current section matches $fname
3760 $pos = count( $this->trxAtomicLevels
) - 1;
3761 list( $savedFname, $savedSectionId, $savepointId ) = $this->trxAtomicLevels
[$pos];
3763 if ( $excisedFnames ) {
3764 $this->queryLogger
->debug( "cancelAtomic: canceling level $pos ($savedFname) " .
3765 "and descendants " . implode( ', ', $excisedFnames ) );
3767 $this->queryLogger
->debug( "cancelAtomic: canceling level $pos ($savedFname)" );
3770 if ( $savedFname !== $fname ) {
3771 throw new DBUnexpectedError(
3773 "Invalid atomic section ended (got $fname but expected $savedFname)."
3777 // Remove the last section (no need to re-index the array)
3778 array_pop( $this->trxAtomicLevels
);
3779 $this->modifyCallbacksForCancel( [ $savedSectionId ] );
3781 if ( $savepointId !== null ) {
3782 // Rollback the transaction to the state just before this atomic section
3783 if ( $savepointId === self
::$NOT_APPLICABLE ) {
3784 $this->rollback( $fname, self
::FLUSHING_INTERNAL
);
3786 $this->doRollbackToSavepoint( $savepointId, $fname );
3787 $this->trxStatus
= self
::STATUS_TRX_OK
; // no exception; recovered
3788 $this->trxStatusIgnoredCause
= null;
3790 } elseif ( $this->trxStatus
> self
::STATUS_TRX_ERROR
) {
3791 // Put the transaction into an error state if it's not already in one
3792 $this->trxStatus
= self
::STATUS_TRX_ERROR
;
3793 $this->trxStatusCause
= new DBUnexpectedError(
3795 "Uncancelable atomic section canceled (got $fname)."
3799 $this->affectedRowCount
= 0; // for the sake of consistency
3802 final public function doAtomicSection(
3803 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
3805 $sectionId = $this->startAtomic( $fname, $cancelable );
3807 $res = $callback( $this, $fname );
3808 } catch ( Exception
$e ) {
3809 $this->cancelAtomic( $fname, $sectionId );
3813 $this->endAtomic( $fname );
3818 final public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
) {
3819 static $modes = [ self
::TRANSACTION_EXPLICIT
, self
::TRANSACTION_INTERNAL
];
3820 if ( !in_array( $mode, $modes, true ) ) {
3821 throw new DBUnexpectedError( $this, "$fname: invalid mode parameter '$mode'." );
3824 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
3825 if ( $this->trxLevel
) {
3826 if ( $this->trxAtomicLevels
) {
3827 $levels = $this->flatAtomicSectionList();
3828 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
3829 throw new DBUnexpectedError( $this, $msg );
3830 } elseif ( !$this->trxAutomatic
) {
3831 $msg = "$fname: Explicit transaction already active (from {$this->trxFname}).";
3832 throw new DBUnexpectedError( $this, $msg );
3834 $msg = "$fname: Implicit transaction already active (from {$this->trxFname}).";
3835 throw new DBUnexpectedError( $this, $msg );
3837 } elseif ( $this->getFlag( self
::DBO_TRX
) && $mode !== self
::TRANSACTION_INTERNAL
) {
3838 $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
3839 throw new DBUnexpectedError( $this, $msg );
3842 // Avoid fatals if close() was called
3843 $this->assertOpen();
3845 $this->doBegin( $fname );
3846 $this->trxStatus
= self
::STATUS_TRX_OK
;
3847 $this->trxStatusIgnoredCause
= null;
3848 $this->trxAtomicCounter
= 0;
3849 $this->trxTimestamp
= microtime( true );
3850 $this->trxFname
= $fname;
3851 $this->trxDoneWrites
= false;
3852 $this->trxAutomaticAtomic
= false;
3853 $this->trxAtomicLevels
= [];
3854 $this->trxShortId
= sprintf( '%06x', mt_rand( 0, 0xffffff ) );
3855 $this->trxWriteDuration
= 0.0;
3856 $this->trxWriteQueryCount
= 0;
3857 $this->trxWriteAffectedRows
= 0;
3858 $this->trxWriteAdjDuration
= 0.0;
3859 $this->trxWriteAdjQueryCount
= 0;
3860 $this->trxWriteCallers
= [];
3861 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
3862 // Get an estimate of the replication lag before any such queries.
3863 $this->trxReplicaLag
= null; // clear cached value first
3864 $this->trxReplicaLag
= $this->getApproximateLagStatus()['lag'];
3865 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
3866 // caller will think its OK to muck around with the transaction just because startAtomic()
3867 // has not yet completed (e.g. setting trxAtomicLevels).
3868 $this->trxAutomatic
= ( $mode === self
::TRANSACTION_INTERNAL
);
3872 * Issues the BEGIN command to the database server.
3874 * @see Database::begin()
3875 * @param string $fname
3877 protected function doBegin( $fname ) {
3878 $this->query( 'BEGIN', $fname );
3879 $this->trxLevel
= 1;
3882 final public function commit( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
) {
3883 static $modes = [ self
::FLUSHING_ONE
, self
::FLUSHING_ALL_PEERS
, self
::FLUSHING_INTERNAL
];
3884 if ( !in_array( $flush, $modes, true ) ) {
3885 throw new DBUnexpectedError( $this, "$fname: invalid flush parameter '$flush'." );
3888 if ( $this->trxLevel
&& $this->trxAtomicLevels
) {
3889 // There are still atomic sections open; this cannot be ignored
3890 $levels = $this->flatAtomicSectionList();
3891 throw new DBUnexpectedError(
3893 "$fname: Got COMMIT while atomic sections $levels are still open."
3897 if ( $flush === self
::FLUSHING_INTERNAL ||
$flush === self
::FLUSHING_ALL_PEERS
) {
3898 if ( !$this->trxLevel
) {
3899 return; // nothing to do
3900 } elseif ( !$this->trxAutomatic
) {
3901 throw new DBUnexpectedError(
3903 "$fname: Flushing an explicit transaction, getting out of sync."
3907 if ( !$this->trxLevel
) {
3908 $this->queryLogger
->error(
3909 "$fname: No transaction to commit, something got out of sync." );
3910 return; // nothing to do
3911 } elseif ( $this->trxAutomatic
) {
3912 throw new DBUnexpectedError(
3914 "$fname: Expected mass commit of all peer transactions (DBO_TRX set)."
3919 // Avoid fatals if close() was called
3920 $this->assertOpen();
3922 $this->runOnTransactionPreCommitCallbacks();
3924 $writeTime = $this->pendingWriteQueryDuration( self
::ESTIMATE_DB_APPLY
);
3925 $this->doCommit( $fname );
3926 $this->trxStatus
= self
::STATUS_TRX_NONE
;
3928 if ( $this->trxDoneWrites
) {
3929 $this->lastWriteTime
= microtime( true );
3930 $this->trxProfiler
->transactionWritingOut(
3932 $this->getDomainID(),
3935 $this->trxWriteAffectedRows
3939 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
3940 if ( $flush !== self
::FLUSHING_ALL_PEERS
) {
3941 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_COMMIT
);
3942 $this->runTransactionListenerCallbacks( self
::TRIGGER_COMMIT
);
3947 * Issues the COMMIT command to the database server.
3949 * @see Database::commit()
3950 * @param string $fname
3952 protected function doCommit( $fname ) {
3953 if ( $this->trxLevel
) {
3954 $this->query( 'COMMIT', $fname );
3955 $this->trxLevel
= 0;
3959 final public function rollback( $fname = __METHOD__
, $flush = '' ) {
3960 $trxActive = $this->trxLevel
;
3962 if ( $flush !== self
::FLUSHING_INTERNAL
&& $flush !== self
::FLUSHING_ALL_PEERS
) {
3963 if ( $this->getFlag( self
::DBO_TRX
) ) {
3964 throw new DBUnexpectedError(
3966 "$fname: Expected mass rollback of all peer transactions (DBO_TRX set)."
3972 // Avoid fatals if close() was called
3973 $this->assertOpen();
3975 $writeTime = $this->pendingWriteQueryDuration( self
::ESTIMATE_DB_APPLY
);
3976 $this->doRollback( $fname );
3977 $this->trxStatus
= self
::STATUS_TRX_NONE
;
3978 $this->trxAtomicLevels
= [];
3980 if ( $this->trxDoneWrites
) {
3981 $this->trxProfiler
->transactionWritingOut(
3983 $this->getDomainID(),
3986 $this->trxWriteAffectedRows
3991 // Clear any commit-dependant callbacks. They might even be present
3992 // only due to transaction rounds, with no SQL transaction being active
3993 $this->trxIdleCallbacks
= [];
3994 $this->trxPreCommitCallbacks
= [];
3996 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
3997 if ( $trxActive && $flush !== self
::FLUSHING_ALL_PEERS
) {
3999 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
4000 } catch ( Exception
$e ) {
4001 // already logged; finish and let LoadBalancer move on during mass-rollback
4004 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
4005 } catch ( Exception
$e ) {
4006 // already logged; let LoadBalancer move on during mass-rollback
4009 $this->affectedRowCount
= 0; // for the sake of consistency
4014 * Issues the ROLLBACK command to the database server.
4016 * @see Database::rollback()
4017 * @param string $fname
4019 protected function doRollback( $fname ) {
4020 if ( $this->trxLevel
) {
4021 # Disconnects cause rollback anyway, so ignore those errors
4022 $ignoreErrors = true;
4023 $this->query( 'ROLLBACK', $fname, $ignoreErrors );
4024 $this->trxLevel
= 0;
4028 public function flushSnapshot( $fname = __METHOD__
) {
4029 if ( $this->writesOrCallbacksPending() ||
$this->explicitTrxActive() ) {
4030 // This only flushes transactions to clear snapshots, not to write data
4031 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4032 throw new DBUnexpectedError(
4034 "$fname: Cannot flush snapshot because writes are pending ($fnames)."
4038 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
4041 public function explicitTrxActive() {
4042 return $this->trxLevel
&& ( $this->trxAtomicLevels ||
!$this->trxAutomatic
);
4045 public function duplicateTableStructure(
4046 $oldName, $newName, $temporary = false, $fname = __METHOD__
4048 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4051 public function listTables( $prefix = null, $fname = __METHOD__
) {
4052 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4055 public function listViews( $prefix = null, $fname = __METHOD__
) {
4056 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4059 public function timestamp( $ts = 0 ) {
4060 $t = new ConvertibleTimestamp( $ts );
4061 // Let errors bubble up to avoid putting garbage in the DB
4062 return $t->getTimestamp( TS_MW
);
4065 public function timestampOrNull( $ts = null ) {
4066 if ( is_null( $ts ) ) {
4069 return $this->timestamp( $ts );
4073 public function affectedRows() {
4074 return ( $this->affectedRowCount
=== null )
4075 ?
$this->fetchAffectedRowCount() // default to driver value
4076 : $this->affectedRowCount
;
4080 * @return int Number of retrieved rows according to the driver
4082 abstract protected function fetchAffectedRowCount();
4085 * Take the result from a query, and wrap it in a ResultWrapper if
4086 * necessary. Boolean values are passed through as is, to indicate success
4087 * of write queries or failure.
4089 * Once upon a time, Database::query() returned a bare MySQL result
4090 * resource, and it was necessary to call this function to convert it to
4091 * a wrapper. Nowadays, raw database objects are never exposed to external
4092 * callers, so this is unnecessary in external code.
4094 * @param bool|ResultWrapper|resource $result
4095 * @return bool|ResultWrapper
4097 protected function resultObject( $result ) {
4100 } elseif ( $result instanceof ResultWrapper
) {
4102 } elseif ( $result === true ) {
4103 // Successful write query
4106 return new ResultWrapper( $this, $result );
4110 public function ping( &$rtt = null ) {
4111 // Avoid hitting the server if it was hit recently
4112 if ( $this->isOpen() && ( microtime( true ) - $this->lastPing
) < self
::PING_TTL
) {
4113 if ( !func_num_args() ||
$this->rttEstimate
> 0 ) {
4114 $rtt = $this->rttEstimate
;
4115 return true; // don't care about $rtt
4119 // This will reconnect if possible or return false if not
4120 $this->clearFlag( self
::DBO_TRX
, self
::REMEMBER_PRIOR
);
4121 $ok = ( $this->query( self
::PING_QUERY
, __METHOD__
, true ) !== false );
4122 $this->restoreFlags( self
::RESTORE_PRIOR
);
4125 $rtt = $this->rttEstimate
;
4132 * Close any existing (dead) database connection and open a new connection
4134 * @param string $fname
4135 * @return bool True if new connection is opened successfully, false if error
4137 protected function replaceLostConnection( $fname ) {
4138 $this->closeConnection();
4139 $this->opened
= false;
4140 $this->conn
= false;
4148 $this->tablePrefix()
4150 $this->lastPing
= microtime( true );
4153 $this->connLogger
->warning(
4154 $fname . ': lost connection to {dbserver}; reconnected',
4156 'dbserver' => $this->getServer(),
4157 'trace' => ( new RuntimeException() )->getTraceAsString()
4160 } catch ( DBConnectionError
$e ) {
4163 $this->connLogger
->error(
4164 $fname . ': lost connection to {dbserver} permanently',
4165 [ 'dbserver' => $this->getServer() ]
4169 $this->handleSessionLoss();
4174 public function getSessionLagStatus() {
4175 return $this->getRecordedTransactionLagStatus() ?
: $this->getApproximateLagStatus();
4179 * Get the replica DB lag when the current transaction started
4181 * This is useful when transactions might use snapshot isolation
4182 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
4183 * is this lag plus transaction duration. If they don't, it is still
4184 * safe to be pessimistic. This returns null if there is no transaction.
4186 * This returns null if the lag status for this transaction was not yet recorded.
4188 * @return array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
4191 final protected function getRecordedTransactionLagStatus() {
4192 return ( $this->trxLevel
&& $this->trxReplicaLag
!== null )
4193 ?
[ 'lag' => $this->trxReplicaLag
, 'since' => $this->trxTimestamp() ]
4198 * Get a replica DB lag estimate for this server
4200 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
4203 protected function getApproximateLagStatus() {
4205 'lag' => $this->getLBInfo( 'replica' ) ?
$this->getLag() : 0,
4206 'since' => microtime( true )
4211 * Merge the result of getSessionLagStatus() for several DBs
4212 * using the most pessimistic values to estimate the lag of
4213 * any data derived from them in combination
4215 * This is information is useful for caching modules
4217 * @see WANObjectCache::set()
4218 * @see WANObjectCache::getWithSetCallback()
4220 * @param IDatabase $db1
4221 * @param IDatabase|null $db2 [optional]
4222 * @return array Map of values:
4223 * - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
4224 * - since: oldest UNIX timestamp of any of the DB lag estimates
4225 * - pending: whether any of the DBs have uncommitted changes
4229 public static function getCacheSetOptions( IDatabase
$db1, IDatabase
$db2 = null ) {
4230 $res = [ 'lag' => 0, 'since' => INF
, 'pending' => false ];
4231 foreach ( func_get_args() as $db ) {
4232 /** @var IDatabase $db */
4233 $status = $db->getSessionLagStatus();
4234 if ( $status['lag'] === false ) {
4235 $res['lag'] = false;
4236 } elseif ( $res['lag'] !== false ) {
4237 $res['lag'] = max( $res['lag'], $status['lag'] );
4239 $res['since'] = min( $res['since'], $status['since'] );
4240 $res['pending'] = $res['pending'] ?
: $db->writesPending();
4246 public function getLag() {
4250 public function maxListLen() {
4254 public function encodeBlob( $b ) {
4258 public function decodeBlob( $b ) {
4259 if ( $b instanceof Blob
) {
4265 public function setSessionOptions( array $options ) {
4268 public function sourceFile(
4270 callable
$lineCallback = null,
4271 callable
$resultCallback = null,
4273 callable
$inputCallback = null
4275 Wikimedia\
suppressWarnings();
4276 $fp = fopen( $filename, 'r' );
4277 Wikimedia\restoreWarnings
();
4279 if ( false === $fp ) {
4280 throw new RuntimeException( "Could not open \"{$filename}\".\n" );
4284 $fname = __METHOD__
. "( $filename )";
4288 $error = $this->sourceStream(
4289 $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
4290 } catch ( Exception
$e ) {
4300 public function setSchemaVars( $vars ) {
4301 $this->schemaVars
= $vars;
4304 public function sourceStream(
4306 callable
$lineCallback = null,
4307 callable
$resultCallback = null,
4308 $fname = __METHOD__
,
4309 callable
$inputCallback = null
4311 $delimiterReset = new ScopedCallback(
4312 function ( $delimiter ) {
4313 $this->delimiter
= $delimiter;
4315 [ $this->delimiter
]
4319 while ( !feof( $fp ) ) {
4320 if ( $lineCallback ) {
4321 call_user_func( $lineCallback );
4324 $line = trim( fgets( $fp ) );
4326 if ( $line == '' ) {
4330 if ( '-' == $line[0] && '-' == $line[1] ) {
4338 $done = $this->streamStatementEnd( $cmd, $line );
4342 if ( $done ||
feof( $fp ) ) {
4343 $cmd = $this->replaceVars( $cmd );
4345 if ( $inputCallback ) {
4346 $callbackResult = $inputCallback( $cmd );
4348 if ( is_string( $callbackResult ) ||
!$callbackResult ) {
4349 $cmd = $callbackResult;
4354 $res = $this->query( $cmd, $fname );
4356 if ( $resultCallback ) {
4357 $resultCallback( $res, $this );
4360 if ( false === $res ) {
4361 $err = $this->lastError();
4363 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
4370 ScopedCallback
::consume( $delimiterReset );
4375 * Called by sourceStream() to check if we've reached a statement end
4377 * @param string &$sql SQL assembled so far
4378 * @param string &$newLine New line about to be added to $sql
4379 * @return bool Whether $newLine contains end of the statement
4381 public function streamStatementEnd( &$sql, &$newLine ) {
4382 if ( $this->delimiter
) {
4384 $newLine = preg_replace(
4385 '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
4386 if ( $newLine != $prev ) {
4395 * Database independent variable replacement. Replaces a set of variables
4396 * in an SQL statement with their contents as given by $this->getSchemaVars().
4398 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
4400 * - '{$var}' should be used for text and is passed through the database's
4402 * - `{$var}` should be used for identifiers (e.g. table and database names).
4403 * It is passed through the database's addIdentifierQuotes method which
4404 * can be overridden if the database uses something other than backticks.
4405 * - / *_* / or / *$wgDBprefix* / passes the name that follows through the
4406 * database's tableName method.
4407 * - / *i* / passes the name that follows through the database's indexName method.
4408 * - In all other cases, / *$var* / is left unencoded. Except for table options,
4409 * its use should be avoided. In 1.24 and older, string encoding was applied.
4411 * @param string $ins SQL statement to replace variables in
4412 * @return string The new SQL statement with variables replaced
4414 protected function replaceVars( $ins ) {
4415 $vars = $this->getSchemaVars();
4416 return preg_replace_callback(
4418 /\* (\$wgDBprefix|[_i]) \*/ (\w*) | # 1-2. tableName, indexName
4419 \'\{\$ (\w+) }\' | # 3. addQuotes
4420 `\{\$ (\w+) }` | # 4. addIdentifierQuotes
4421 /\*\$ (\w+) \*/ # 5. leave unencoded
4423 function ( $m ) use ( $vars ) {
4424 // Note: Because of <https://bugs.php.net/bug.php?id=51881>,
4425 // check for both nonexistent keys *and* the empty string.
4426 if ( isset( $m[1] ) && $m[1] !== '' ) {
4427 if ( $m[1] === 'i' ) {
4428 return $this->indexName( $m[2] );
4430 return $this->tableName( $m[2] );
4432 } elseif ( isset( $m[3] ) && $m[3] !== '' && array_key_exists( $m[3], $vars ) ) {
4433 return $this->addQuotes( $vars[$m[3]] );
4434 } elseif ( isset( $m[4] ) && $m[4] !== '' && array_key_exists( $m[4], $vars ) ) {
4435 return $this->addIdentifierQuotes( $vars[$m[4]] );
4436 } elseif ( isset( $m[5] ) && $m[5] !== '' && array_key_exists( $m[5], $vars ) ) {
4437 return $vars[$m[5]];
4447 * Get schema variables. If none have been set via setSchemaVars(), then
4448 * use some defaults from the current object.
4452 protected function getSchemaVars() {
4453 if ( $this->schemaVars
) {
4454 return $this->schemaVars
;
4456 return $this->getDefaultSchemaVars();
4461 * Get schema variables to use if none have been set via setSchemaVars().
4463 * Override this in derived classes to provide variables for tables.sql
4464 * and SQL patch files.
4468 protected function getDefaultSchemaVars() {
4472 public function lockIsFree( $lockName, $method ) {
4473 // RDBMs methods for checking named locks may or may not count this thread itself.
4474 // In MySQL, IS_FREE_LOCK() returns 0 if the thread already has the lock. This is
4475 // the behavior choosen by the interface for this method.
4476 return !isset( $this->namedLocksHeld
[$lockName] );
4479 public function lock( $lockName, $method, $timeout = 5 ) {
4480 $this->namedLocksHeld
[$lockName] = 1;
4485 public function unlock( $lockName, $method ) {
4486 unset( $this->namedLocksHeld
[$lockName] );
4491 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
4492 if ( $this->writesOrCallbacksPending() ) {
4493 // This only flushes transactions to clear snapshots, not to write data
4494 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4495 throw new DBUnexpectedError(
4497 "$fname: Cannot flush pre-lock snapshot because writes are pending ($fnames)."
4501 if ( !$this->lock( $lockKey, $fname, $timeout ) ) {
4505 $unlocker = new ScopedCallback( function () use ( $lockKey, $fname ) {
4506 if ( $this->trxLevel() ) {
4507 // There is a good chance an exception was thrown, causing any early return
4508 // from the caller. Let any error handler get a chance to issue rollback().
4509 // If there isn't one, let the error bubble up and trigger server-side rollback.
4510 $this->onTransactionResolution(
4511 function () use ( $lockKey, $fname ) {
4512 $this->unlock( $lockKey, $fname );
4517 $this->unlock( $lockKey, $fname );
4521 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
4526 public function namedLocksEnqueue() {
4530 public function tableLocksHaveTransactionScope() {
4534 final public function lockTables( array $read, array $write, $method ) {
4535 if ( $this->writesOrCallbacksPending() ) {
4536 throw new DBUnexpectedError( $this, "Transaction writes or callbacks still pending." );
4539 if ( $this->tableLocksHaveTransactionScope() ) {
4540 $this->startAtomic( $method );
4543 return $this->doLockTables( $read, $write, $method );
4547 * Helper function for lockTables() that handles the actual table locking
4549 * @param array $read Array of tables to lock for read access
4550 * @param array $write Array of tables to lock for write access
4551 * @param string $method Name of caller
4554 protected function doLockTables( array $read, array $write, $method ) {
4558 final public function unlockTables( $method ) {
4559 if ( $this->tableLocksHaveTransactionScope() ) {
4560 $this->endAtomic( $method );
4562 return true; // locks released on COMMIT/ROLLBACK
4565 return $this->doUnlockTables( $method );
4569 * Helper function for unlockTables() that handles the actual table unlocking
4571 * @param string $method Name of caller
4574 protected function doUnlockTables( $method ) {
4580 * @param string $tableName
4581 * @param string $fName
4582 * @return bool|ResultWrapper
4585 public function dropTable( $tableName, $fName = __METHOD__
) {
4586 if ( !$this->tableExists( $tableName, $fName ) ) {
4589 $sql = "DROP TABLE " . $this->tableName( $tableName ) . " CASCADE";
4591 return $this->query( $sql, $fName );
4594 public function getInfinity() {
4598 public function encodeExpiry( $expiry ) {
4599 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
4600 ?
$this->getInfinity()
4601 : $this->timestamp( $expiry );
4604 public function decodeExpiry( $expiry, $format = TS_MW
) {
4605 if ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() ) {
4609 return ConvertibleTimestamp
::convert( $format, $expiry );
4612 public function setBigSelects( $value = true ) {
4616 public function isReadOnly() {
4617 return ( $this->getReadOnlyReason() !== false );
4621 * @return string|bool Reason this DB is read-only or false if it is not
4623 protected function getReadOnlyReason() {
4624 $reason = $this->getLBInfo( 'readOnlyReason' );
4626 return is_string( $reason ) ?
$reason : false;
4629 public function setTableAliases( array $aliases ) {
4630 $this->tableAliases
= $aliases;
4633 public function setIndexAliases( array $aliases ) {
4634 $this->indexAliases
= $aliases;
4638 * Get the underlying binding connection handle
4640 * Makes sure the connection resource is set (disconnects and ping() failure can unset it).
4641 * This catches broken callers than catch and ignore disconnection exceptions.
4642 * Unlike checking isOpen(), this is safe to call inside of open().
4645 * @throws DBUnexpectedError
4648 protected function getBindingHandle() {
4649 if ( !$this->conn
) {
4650 throw new DBUnexpectedError(
4652 'DB connection was already closed or the connection dropped.'
4663 public function __toString() {
4664 return (string)$this->conn
;
4668 * Make sure that copies do not share the same client binding handle
4669 * @throws DBConnectionError
4671 public function __clone() {
4672 $this->connLogger
->warning(
4673 "Cloning " . static::class . " is not recommended; forking connection:\n" .
4674 ( new RuntimeException() )->getTraceAsString()
4677 if ( $this->isOpen() ) {
4678 // Open a new connection resource without messing with the old one
4679 $this->opened
= false;
4680 $this->conn
= false;
4681 $this->trxEndCallbacks
= []; // don't copy
4682 $this->handleSessionLoss(); // no trx or locks anymore
4689 $this->tablePrefix()
4691 $this->lastPing
= microtime( true );
4696 * Called by serialize. Throw an exception when DB connection is serialized.
4697 * This causes problems on some database engines because the connection is
4698 * not restored on unserialize.
4700 public function __sleep() {
4701 throw new RuntimeException( 'Database serialization may cause problems, since ' .
4702 'the connection is not restored on wakeup.' );
4706 * Run a few simple sanity checks and close dangling connections
4708 public function __destruct() {
4709 if ( $this->trxLevel
&& $this->trxDoneWrites
) {
4710 trigger_error( "Uncommitted DB writes (transaction from {$this->trxFname})." );
4713 $danglingWriters = $this->pendingWriteAndCallbackCallers();
4714 if ( $danglingWriters ) {
4715 $fnames = implode( ', ', $danglingWriters );
4716 trigger_error( "DB transaction writes or callbacks still pending ($fnames)." );
4719 if ( $this->conn
) {
4720 // Avoid connection leaks for sanity. Normally, resources close at script completion.
4721 // The connection might already be closed in zend/hhvm by now, so suppress warnings.
4722 Wikimedia\
suppressWarnings();
4723 $this->closeConnection();
4724 Wikimedia\restoreWarnings
();
4725 $this->conn
= false;
4726 $this->opened
= false;
4732 * @deprecated since 1.28
4734 class_alias( Database
::class, 'DatabaseBase' );
4737 * @deprecated since 1.29
4739 class_alias( Database
::class, 'Database' );